Universal Angular 2

Universal (isomorphic) JavaScript support for Angular 2.

Getting Started with Universal
- w/ NodeJS Server
- w/ ASP.NET Core Server
Modules
- Universal
- preboot.js
Best Practices
What's in a name?
License

Getting Started

* NodeJS :: Universal Starter repo

* ASP.NET Core :: Universal Starter repo

Modules

Universal

Manage your application lifecycle and serialize changes while on the server to be sent to the client.

Documentation

Design Doc

Videos

Angular 2 Universal Patterns - ng-conf, May 2016

Angular Universal Source Code - ReadTheSource, January 2016

Full Stack Angular 2 - AngularConnect, Oct 2015

Angular 2 Server Rendering - Angular U, July 2015

preboot.js

Control server-rendered page and transfer state before client-side web app loads to the client-side-app.

Best Practices

When building Universal components in Angular 2 there are a few things to keep in mind.

Note: Universal currently only works with router-deprecated

Know the difference between attributes and properties in relation to the DOM.
Don't manipulate the nativeElement directly. Use the Renderer. We do this to ensure that in any environment we're able to change our view.
```
constructor(element: ElementRef, renderer: Renderer) {
renderer.setElementStyle(element.nativeElement, 'font-size', 'x-large');
}
```
Don't use any of the browser types provided in the global namespace such as navigator or document. Anything outside of Angular will not be detected when serializing your application into html. If you need access to these types please consider using DOM from "angular2/src/platform/dom/dom_adapter"
Keep your directives stateless as much as possible. For stateful directives, you may need to provide an attribute that reflects the corresponding property with an initial string value such as url in img tag. For our native <img src=""> element the src attribute is reflected as the src property of the element type HTMLImageElement.

What's in a name?

We believe that using the word "universal" is correct when referring to a JavaScript Application that runs in more environments than the browser. (inspired by Universal JavaScript)

License

Index

External modules

"index"

"index":

"node_modules/angular2-express-engine/index"

"node_modules/angular2-express-engine/index":

"node_modules/angular2-express-engine/src/engine"

"node_modules/angular2-express-engine/src/engine":

ExpressEngineExtraOptions

ExpressEngineExtraOptions:

bootloader

bootloader: any

client

client: boolean

reuseProviders

reuseProviders: boolean

selector

selector: string

serializedCmp

serializedCmp: string

server

server: boolean

ExpressEngineConfig

ExpressEngineConfig: any

EXPRESS_PLATFORM

EXPRESS_PLATFORM: any

bootstrapApp

bootstrapApp: string

bootstrapButton

bootstrapButton: string

cache

cache: object

Type declaration

fs

fs: any

angularScript

angularScript(config: any): string

- Defined in node_modules/angular2-express-engine/src/engine.ts:194
Parameters
- config: any
Returns string

bootstrapFunction

bootstrapFunction(config: any): string

- Defined in node_modules/angular2-express-engine/src/engine.ts:248
Parameters
- config: any
Returns string

buildClientScripts

buildClientScripts(html: string, options: any): string

- Defined in node_modules/angular2-express-engine/src/engine.ts:273
Parameters
- html: string
- options: any
Returns string

disposeExpressAngularApp

disposeExpressAngularApp(): void

- Defined in node_modules/angular2-express-engine/src/engine.ts:32
Returns void

disposeExpressPlatform

disposeExpressPlatform(): void

- Defined in node_modules/angular2-express-engine/src/engine.ts:25
Returns void

expressEngine

expressEngine(filePath: string, options?: ExpressEngineConfig, done?: Function): any

- Defined in node_modules/angular2-express-engine/src/engine.ts:43
Parameters
- filePath: string
- Optional options: ExpressEngineConfig
- Optional done: Function
Returns any

ng2Engine

ng2Engine(filePath: string, options: ExpressEngineConfig, done: Function): any

- Defined in node_modules/angular2-express-engine/src/engine.ts:135
Parameters
- filePath: string
- options: ExpressEngineConfig
- done: Function
Returns any

ng2ExpressEngine

ng2ExpressEngine(filePath: string, options: ExpressEngineConfig, done: Function): any

- Defined in node_modules/angular2-express-engine/src/engine.ts:139
Parameters
- filePath: string
- options: ExpressEngineConfig
- done: Function
Returns any

ng2engine

ng2engine(filePath: string, options: ExpressEngineConfig, done: Function): any

- Defined in node_modules/angular2-express-engine/src/engine.ts:130
Parameters
- filePath: string
- options: ExpressEngineConfig
- done: Function
Returns any

prebootScript

prebootScript(config: any): string

- Defined in node_modules/angular2-express-engine/src/engine.ts:183
Parameters
- config: any
Returns string

simpleReplace

simpleReplace(filePath: string, options: ExpressEngineConfig, done: Function): void

- Defined in node_modules/angular2-express-engine/src/engine.ts:144
Parameters
- filePath: string
- options: ExpressEngineConfig
- done: Function
Returns void

EXPRESS_ANGULAR_APP

EXPRESS_ANGULAR_APP: object

directives

directives: null

providers

providers: null

template

"node_modules/angular2-hapi-engine/index"

"node_modules/angular2-hapi-engine/index":

"node_modules/angular2-hapi-engine/src/engine"

"node_modules/angular2-hapi-engine/src/engine":

Runtime

Runtime:

constructor

new Runtime(options: HapiEngineConfig): Runtime

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:45
Parameters
- options: HapiEngineConfig
Returns Runtime

bootstrapApp

bootstrapApp: string

bootstrapButton

bootstrapButton: string

options

options: HapiEngineConfig

angularScript

angularScript(config: any): string

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:154
Parameters
- config: any
Returns string

bootstrapFunction

bootstrapFunction(config: any): string

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:90
Parameters
- config: any
Returns string

buildClientScripts

buildClientScripts(html: string, options: any): string

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:116
Parameters
- html: string
- options: any
Returns string

prebootScript

prebootScript(config: any): string

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:143
Parameters
- config: any
Returns string

render

render(template: string, context: any, done: Function): void

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:48
Parameters
- template: string
- context: any
- done: Function
Returns void

hapiEngine

hapiEngine:

constructor

new hapiEngine(): hapiEngine

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:213
Returns hapiEngine

helpers

helpers: any

partials

partials: any

compile

compile(template: any, options: any, next: any): any

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:228
Parameters
- template: any
- options: any
- next: any
Returns any

registerHelper

registerHelper(name: any, helper: any): void

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:220
Parameters
- name: any
- helper: any
Returns void

registerPartial

registerPartial(name: any, partial: any): void

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:224
Parameters
- name: any
- partial: any
Returns void

HapiEngineExtraOptions

HapiEngineExtraOptions:

bootloader

bootloader: any

client

client: boolean

reuseProviders

reuseProviders: boolean

selector

selector: string

serializedCmp

serializedCmp: string

server

server: boolean

HapiEngineConfig

HapiEngineConfig: any

HAPI_PLATFORM

HAPI_PLATFORM: any

disposeHapiAngularApp

disposeHapiAngularApp(): void

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:37
Returns void

disposeHapiPlatform

disposeHapiPlatform(): void

- Defined in node_modules/angular2-hapi-engine/src/engine.ts:30
Returns void

HAPI_ANGULAR_APP

HAPI_ANGULAR_APP: object

directives

directives: null

providers

providers: null

template

"node_modules/angular2-hapi-engine/src/ts-hoek"

"node_modules/angular2-hapi-engine/src/ts-hoek":

applyToDefaults

applyToDefaults(defaults: any, options?: any, isNullOverride?: any): any

- Defined in node_modules/angular2-hapi-engine/src/ts-hoek.ts:157
Parameters
- defaults: any
- Optional options: any
- Optional isNullOverride: any
Returns any

assert

assert(condition: any, ...args: Array<any>): void

- Defined in node_modules/angular2-hapi-engine/src/ts-hoek.ts:71
Parameters
- condition: any
- Rest ...args: Array<any>
Returns void

clone

clone(obj: any, seen?: any): any

- Defined in node_modules/angular2-hapi-engine/src/ts-hoek.ts:1
Parameters
- obj: any
- Optional seen: any
Returns any

merge

merge(target: any, source: any, isNullOverride: any, isMergeArrays: any): any

- Defined in node_modules/angular2-hapi-engine/src/ts-hoek.ts:98
Parameters
- target: any
- source: any
- isNullOverride: any
- isMergeArrays: any
Returns any

stringify

stringify(...args: Array<any>): any

- Defined in node_modules/angular2-hapi-engine/src/ts-hoek.ts:63
Parameters
- Rest ...args: Array<any>
Returns any

"node_modules/angular2-universal-polyfills/src/dev"

"node_modules/angular2-universal-polyfills/src/dev":

"node_modules/angular2-universal-polyfills/src/ie"

"node_modules/angular2-universal-polyfills/src/ie":

"node_modules/angular2-universal-polyfills/src/polyfills-browser"

"node_modules/angular2-universal-polyfills/src/polyfills-browser":

"node_modules/angular2-universal-polyfills/src/polyfills-node"

"node_modules/angular2-universal-polyfills/src/polyfills-node":

"node_modules/angular2-universal-polyfills/src/prod"

"node_modules/angular2-universal-polyfills/src/prod":

"node_modules/angular2-universal-polyfills/src/test"

"node_modules/angular2-universal-polyfills/src/test":

"node_modules/angular2-universal-polyfills/src/zone-browser"

"node_modules/angular2-universal-polyfills/src/zone-browser":

"node_modules/angular2-universal-polyfills/src/zone-node/index"

"node_modules/angular2-universal-polyfills/src/zone-node/index":

"node_modules/angular2-universal/src/browser/bootstrap"

"node_modules/angular2-universal/src/browser/bootstrap":

prebootCompleted

prebootCompleted: boolean

bootstrap

bootstrap(appComponentType: any, appProviders?: Array<Type | Provider | any | any[]>): Promise<ComponentRef<any>>

- Defined in node_modules/angular2-universal/src/browser/bootstrap.ts:15
Parameters
- appComponentType: any
- Default value appProviders: Array<Type | Provider | any | any[]> = null
Returns Promise<ComponentRef<any>>

prebootComplete

prebootComplete(value?: any): any

- Defined in node_modules/angular2-universal/src/browser/bootstrap.ts:8
Parameters
- Optional value: any
Returns any

"node_modules/angular2-universal/src/browser/browser"

"node_modules/angular2-universal/src/browser/browser":

"node_modules/angular2-universal/src/browser/env"

"node_modules/angular2-universal/src/browser/env":

isBrowser

isBrowser: boolean

isNode

isNode: boolean

"node_modules/angular2-universal/src/browser/http"

"node_modules/angular2-universal/src/browser/http":

BROWSER_HTTP_PROVIDERS

BROWSER_HTTP_PROVIDERS: Array<any>

BROWSER_JSONP_PROVIDERS

BROWSER_JSONP_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/browser/index"

"node_modules/angular2-universal/src/browser/index":

"node_modules/angular2-universal/src/browser/ng_preload_cache"

"node_modules/angular2-universal/src/browser/ng_preload_cache":

NgPreloadCacheHttp

NgPreloadCacheHttp:

constructor

new NgPreloadCacheHttp(_backend: ConnectionBackend, _defaultOptions: RequestOptions): NgPreloadCacheHttp

Overwrites Http.__constructor
- Defined in node_modules/angular2-universal/src/browser/ng_preload_cache.ts:29
Parameters
- _backend: ConnectionBackend
- _defaultOptions: RequestOptions
Returns NgPreloadCacheHttp

_backend

_backend: ConnectionBackend

_defaultOptions

_defaultOptions: RequestOptions

prime

prime: boolean

delete

delete(url: string, options: any): Observable<Response> | EventEmitter<any>

Overwrites Http.delete
- Defined in node_modules/angular2-universal/src/browser/ng_preload_cache.ts:84
Parameters
- url: string
- options: any
Returns Observable<Response> | EventEmitter<any>

get

get(url: string, options: any): Observable<Response> | EventEmitter<any>

Overwrites Http.get
- Defined in node_modules/angular2-universal/src/browser/ng_preload_cache.ts:72
Parameters
- url: string
- options: any
Returns Observable<Response> | EventEmitter<any>

head

head(url: string, options: any): Observable<Response> | EventEmitter<any>

Overwrites Http.head
- Defined in node_modules/angular2-universal/src/browser/ng_preload_cache.ts:92
Parameters
- url: string
- options: any
Returns Observable<Response> | EventEmitter<any>

patch

patch(url: string, body: string, options: any): Observable<Response> | EventEmitter<any>

Overwrites Http.patch
- Defined in node_modules/angular2-universal/src/browser/ng_preload_cache.ts:88
Parameters
- url: string
- body: string
- options: any
Returns Observable<Response> | EventEmitter<any>

post

post(url: string, body: string, options: any): Observable<Response> | EventEmitter<any>

Overwrites Http.post
- Defined in node_modules/angular2-universal/src/browser/ng_preload_cache.ts:76
Parameters
- url: string
- body: string
- options: any
Returns Observable<Response> | EventEmitter<any>

preload

preload(method: any): Observable<any> | EventEmitter<any>

- Defined in node_modules/angular2-universal/src/browser/ng_preload_cache.ts:36
Parameters
- method: any
Returns Observable<any> | EventEmitter<any>

put

put(url: string, body: string, options: any): Observable<Response> | EventEmitter<any>

Overwrites Http.put
- Defined in node_modules/angular2-universal/src/browser/ng_preload_cache.ts:80
Parameters
- url: string
- body: string
- options: any
Returns Observable<Response> | EventEmitter<any>

request

request(url: string, options: any): Observable<Response> | EventEmitter<any>

Overwrites Http.request
- Defined in node_modules/angular2-universal/src/browser/ng_preload_cache.ts:68
Parameters
- url: string
- options: any
Returns Observable<Response> | EventEmitter<any>

NG_PRELOAD_CACHE_PROVIDERS

NG_PRELOAD_CACHE_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/browser/platform"

"node_modules/angular2-universal/src/browser/platform":

"node_modules/angular2-universal/src/browser/router"

"node_modules/angular2-universal/src/browser/router":

BROWSER_ROUTER_PROVIDERS

BROWSER_ROUTER_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/common/cookie"

"node_modules/angular2-universal/src/common/cookie":

Cookie

Cookie:

An abstract class for handling cookies.

get

get(key?: string): string

- Defined in node_modules/angular2-universal/src/common/cookie.ts:15
Parameters
- Optional key: string
Returns string

remove

remove(key: string, attributes?: CookieAttributes): any

- Defined in node_modules/angular2-universal/src/common/cookie.ts:17
Parameters
- key: string
- Optional attributes: CookieAttributes
Returns any

set

set(key: string, value: string, attributes?: CookieAttributes): void

- Defined in node_modules/angular2-universal/src/common/cookie.ts:13
Parameters
- key: string
- value: string
- Optional attributes: CookieAttributes
Returns void

toJSON

toJSON(): Object

- Defined in node_modules/angular2-universal/src/common/cookie.ts:19
Returns Object

CookieAttributes

CookieAttributes:

domain

domain: string

expires

expires: number | Date

path

path: string

secure

secure: boolean

"node_modules/angular2-universal/src/common/http"

"node_modules/angular2-universal/src/common/http":

"node_modules/angular2-universal/src/common/index"

"node_modules/angular2-universal/src/common/index":

"node_modules/angular2-universal/src/common/localStorage"

"node_modules/angular2-universal/src/common/localStorage":

LocalStorage

LocalStorage:

The Storage abstract class of the Web Storage API provides access to local storage for a particular domain.

length

length: number

clear

clear(): void

- Defined in node_modules/angular2-universal/src/common/localstorage.ts:17
Returns void

getItem

getItem(): string

- Defined in node_modules/angular2-universal/src/common/localstorage.ts:11
Returns string

key

key(index: number): string

- Defined in node_modules/angular2-universal/src/common/localstorage.ts:15
Parameters
- index: number
Returns string

removeItem

removeItem(key: string): void

- Defined in node_modules/angular2-universal/src/common/localstorage.ts:13
Parameters
- key: string
Returns void

setItem

setItem(key: string, value: string): void

- Defined in node_modules/angular2-universal/src/common/localstorage.ts:9
Parameters
- key: string
- value: string
Returns void

toJSON

toJSON(): Object

- Defined in node_modules/angular2-universal/src/common/localstorage.ts:19
Returns Object

"node_modules/angular2-universal/src/common/title"

"node_modules/angular2-universal/src/common/title":

Title

Title:

An abstract service that can be used to get and set the title of a current HTML document.

getTitle

getTitle(): string

- Defined in node_modules/angular2-universal/src/common/title.ts:6
Returns string

setTitle

setTitle(title: string): void

- Defined in node_modules/angular2-universal/src/common/title.ts:8
Parameters
- title: string
Returns void

"node_modules/angular2-universal/src/common/tokens/index"

"node_modules/angular2-universal/src/common/tokens/index":

BASE_URL

BASE_URL: OpaqueToken

COOKIE_KEY

COOKIE_KEY: OpaqueToken

ORIGIN_URL

ORIGIN_URL: OpaqueToken

PRIME_CACHE

PRIME_CACHE: OpaqueToken

REQUEST_URL

REQUEST_URL: OpaqueToken

"node_modules/angular2-universal/src/global"

"node_modules/angular2-universal/src/global":

___global

___global(m: any): void

- Defined in node_modules/angular2-universal/src/global.ts:4
Parameters
- m: any
Returns void

"node_modules/angular2-universal/src/node/bootloader"

"node_modules/angular2-universal/src/node/bootloader":

Bootloader

Bootloader:

constructor

new Bootloader(config: BootloaderConfig): Bootloader

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:64
Parameters
- config: BootloaderConfig
Returns Bootloader

applicationRef

applicationRef: any

disposed

disposed: boolean

pending

pending: boolean

pendingDisposed

pendingDisposed: boolean

platformRef

platformRef: any

_applicationAll

_applicationAll(config?: AppConfig): Promise<ConfigRefs>

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:243
Parameters
- Default value config: AppConfig = {}
Returns Promise<ConfigRefs>

_async

_async(configRefs: ConfigRefs): Promise<ConfigRefs>

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:273
Parameters
- configRefs: ConfigRefs
Returns Promise<ConfigRefs>

_bootstrapAll

_bootstrapAll(Components?: Array<any>, componentProviders?: Array<any>): Promise<Array<any>>

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:232
Parameters
- Optional Components: Array<any>
- Optional componentProviders: Array<any>
Returns Promise<Array<any>>

_deprecated

_deprecated(config: any): any

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:362
Parameters
- config: any
Returns any

_preboot

_preboot(configRefs: ConfigRefs): Promise<ConfigRefs>

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:331
Parameters
- configRefs: ConfigRefs
Returns Promise<ConfigRefs>

application

application(document?: any, providers?: any): any

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:103
Parameters
- Optional document: any
- Optional providers: any
Returns any

bootstrap

bootstrap(Component?: any | Array<any>): Promise<any>

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:114
Parameters
- Optional Component: any | Array<any>
Returns Promise<any>

dispose

dispose(): void

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:353
Returns void

document

document(document?: string | Object): Object

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:89
Parameters
- Default value document: string | Object = null
Returns Object

platform

platform(providers?: any): PlatformRef

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:97
Parameters
- Optional providers: any
Returns PlatformRef

serialize

serialize(Component?: any | Array<any>): Promise<any>

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:124
Parameters
- Optional Component: any | Array<any>
Returns Promise<any>

serializeApplication

serializeApplication(config?: AppConfig | any, providers?: Array<any>): Promise<any> | any

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:129
Parameters
- Optional config: AppConfig | any
- Optional providers: Array<any>
Returns Promise<any> | any

applicationRefToString

applicationRefToString(applicationRefs: any): string

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:75
Parameters
- applicationRefs: any
Returns string

create

create(config: any): Bootloader

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:71
Parameters
- config: any
Returns Bootloader

parseDocument

parseDocument(document: string): Object

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:85
Parameters
- document: string
Returns Object

parseFragment

parseFragment(document: string): Object

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:84
Parameters
- document: string
Returns Object

serializeDocument

serializeDocument(document: Object): string

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:86
Parameters
- document: Object
Returns string

_config

_config: object

async

async: boolean

preboot

preboot: boolean

AppConfig

AppConfig:

directives

directives: Array<any>

providers

providers: Array<any>

template

BootloaderConfig

BootloaderConfig:

async

async: boolean

beautify

beautify: boolean

bootloader

bootloader: Bootloader | any

component

component: any

componentProviders

componentProviders: Array<any>

directives

directives: Array<any>

maxZoneTurns

maxZoneTurns: number

ngDoCheck

ngDoCheck: function

Type declaration

- (config: ConfigRef, ngZone: NgZone): boolean
- Parameters
  - config: ConfigRef
  - ngZone: NgZone
  Returns boolean

ngOnInit

ngOnInit: function

Type declaration

- (config?: ConfigRefs, document?: any): any | Promise<any> | ConfigRefs
- Parameters
 - Optional config: ConfigRefs
 - Optional document: any
 Returns any | Promise<any> | ConfigRefs

ngOnRendered

ngOnRendered: function

Type declaration

- (rendered?: string): string | any | Promise<any>
- Parameters
 - Optional rendered: string
 Returns string | any | Promise<any>

ngOnStable

ngOnStable: function

Type declaration

- (config?: ConfigRefs, document?: any): any | Promise<any> | ConfigRefs
- Parameters
 - Optional config: ConfigRefs
 - Optional document: any
 Returns any | Promise<any> | ConfigRefs

platformProviders

platformProviders: Array<any>

preboot

preboot: boolean | any

precache

precache: boolean

prime

prime: boolean

primeCache

primeCache: boolean

providers

providers: Array<any>

template

ConfigRef

ConfigRef: object

Type declaration

applicationRef: ApplicationRef
componentRef: ComponentRef<any>

ConfigRefs

ConfigRefs: Array<ConfigRef>

DOM

DOM: any

bootloader

bootloader(config?: BootloaderConfig): Bootloader

- Defined in node_modules/angular2-universal/src/node/bootloader.ts:378
Parameters
- Default value config: BootloaderConfig = {}
Returns Bootloader

"node_modules/angular2-universal/src/node/directives/index"

"node_modules/angular2-universal/src/node/directives/index":

NODE_DIRECTIVES

NODE_DIRECTIVES: Array<any>

NODE_FORM_DIRECTIVES

NODE_FORM_DIRECTIVES: Array<any>

NODE_PLATFORM_DIRECTIVES

NODE_PLATFORM_DIRECTIVES: Array<any>

"node_modules/angular2-universal/src/node/directives/node_form"

"node_modules/angular2-universal/src/node/directives/node_form":

NodeForm

NodeForm:

constructor

new NodeForm(element: ElementRef, renderer: Renderer, appLocation?: string): NodeForm

- Defined in node_modules/angular2-universal/src/node/directives/node_form.ts:22
Parameters
- element: ElementRef
- renderer: Renderer
- Optional appLocation: string
Returns NodeForm

APP_LOCATION

APP_LOCATION: OpaqueToken

CONST_EXPR

CONST_EXPR(v: any): any

- Defined in node_modules/angular2-universal/src/node/directives/node_form.ts:13
Parameters
- v: any
Returns any

"node_modules/angular2-universal/src/node/directives/node_universal_styles"

"node_modules/angular2-universal/src/node/directives/node_universal_styles":

NodeUniversalStyles

NodeUniversalStyles:

constructor

new NodeUniversalStyles(el: ElementRef, domSharedStylesHost: DomSharedStylesHost): NodeUniversalStyles

- Defined in node_modules/angular2-universal/src/node/directives/node_universal_styles.ts:8
Parameters
- el: ElementRef
- domSharedStylesHost: DomSharedStylesHost
Returns NodeUniversalStyles

domSharedStylesHost

domSharedStylesHost: DomSharedStylesHost

el

el: ElementRef

"node_modules/angular2-universal/src/node/env"

"node_modules/angular2-universal/src/node/env":

isBrowser

isBrowser: boolean

isNode

isNode: boolean

"node_modules/angular2-universal/src/node/helper"

"node_modules/angular2-universal/src/node/helper":

directiveResolver

directiveResolver: any

arrayFlattenTree

arrayFlattenTree(children: any[], arr: any[]): any[]

- Defined in node_modules/angular2-universal/src/node/helper.ts:70
Parameters
- children: any[]
- arr: any[]
Returns any[]

cssHyphenate

cssHyphenate(propertyName: string): string

- Defined in node_modules/angular2-universal/src/node/helper.ts:20
Parameters
- propertyName: string
Returns string

escapeRegExp

escapeRegExp(str: any): string

- Defined in node_modules/angular2-universal/src/node/helper.ts:12
Parameters
- str: any
Returns string

queryParamsToBoolean

queryParamsToBoolean(query: any): any

- Defined in node_modules/angular2-universal/src/node/helper.ts:48
Parameters
- query: any
Returns any

selectorRegExpFactory

selectorRegExpFactory(selector: string): RegExp

- Defined in node_modules/angular2-universal/src/node/helper.ts:59
Parameters
- selector: string
Returns RegExp

selectorResolver

selectorResolver(componentType: any): string

- Defined in node_modules/angular2-universal/src/node/helper.ts:8
Parameters
- componentType: any
Returns string

serverDirectiveResolver

serverDirectiveResolver(componentType: any): any

- Defined in node_modules/angular2-universal/src/node/helper.ts:4
Parameters
- componentType: any
Returns any

showDebug

showDebug(options?: object): string

- Defined in node_modules/angular2-universal/src/node/helper.ts:26
Parameters
- Default value options: object = {}
Returns string

stringToBoolean

stringToBoolean(txt: any): boolean | string

- Defined in node_modules/angular2-universal/src/node/helper.ts:39
Parameters
- txt: any
Returns boolean | string

stringify

stringify(obj: any, replacer?: any, spaces?: number): string

- Defined in node_modules/angular2-universal/src/node/helper.ts:16
Parameters
- obj: any
- Default value replacer: any = null
- Default value spaces: number = 2
Returns string

"node_modules/angular2-universal/src/node/http/index"

"node_modules/angular2-universal/src/node/http/index":

HTTP_PROVIDERS

HTTP_PROVIDERS: Array<any>

NODE_HTTP_PROVIDERS

NODE_HTTP_PROVIDERS: Array<any>

NODE_HTTP_PROVIDERS_COMMON

NODE_HTTP_PROVIDERS_COMMON: Array<any>

NODE_JSONP_PROVIDERS

NODE_JSONP_PROVIDERS: Array<any>

NODE_PRELOAD_CACHE_HTTP_PROVIDERS

NODE_PRELOAD_CACHE_HTTP_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/node/http/node_http"

"node_modules/angular2-universal/src/node/http/node_http":

NodeBackend

NodeBackend:

constructor

new NodeBackend(_baseResponseOptions: ResponseOptions, _ngZone: NgZone, _baseUrl: string, _originUrl: string): NodeBackend

- Defined in node_modules/angular2-universal/src/node/http/node_http.ts:243
Parameters
- _baseResponseOptions: ResponseOptions
- _ngZone: NgZone
- _baseUrl: string
- _originUrl: string
Returns NodeBackend

_baseResponseOptions

_baseResponseOptions: ResponseOptions

_baseUrl

_baseUrl: string

_ngZone

_ngZone: NgZone

_originUrl

_originUrl: string

createConnection

createConnection(request: Request): NodeConnection

- Defined in node_modules/angular2-universal/src/node/http/node_http.ts:250
Parameters
- request: Request
Returns NodeConnection

NodeConnection

NodeConnection:

constructor

new NodeConnection(req: Request, baseResponseOptions: ResponseOptions, ngZone: NgZone, originUrl?: string, baseUrl?: string, cookie?: Cookie, cookieKey?: any): NodeConnection

- Defined in node_modules/angular2-universal/src/node/http/node_http.ts:30
Parameters
- req: Request
- baseResponseOptions: ResponseOptions
- ngZone: NgZone
- Default value originUrl: string = ""
- Optional baseUrl: string
- Optional cookie: Cookie
- Optional cookieKey: any
Returns NodeConnection

readyState

readyState: ReadyState

request

request: Request

response

response: Observable<Response> | Observable<any>

NodeJSONPConnection

NodeJSONPConnection:

constructor

new NodeJSONPConnection(req: Request, baseResponseOptions: ResponseOptions, ngZone: NgZone, originUrl?: string, baseUrl?: string): NodeJSONPConnection

- Defined in node_modules/angular2-universal/src/node/http/node_http.ts:138
Parameters
- req: Request
- baseResponseOptions: ResponseOptions
- ngZone: NgZone
- Default value originUrl: string = ""
- Optional baseUrl: string
Returns NodeJSONPConnection

readyState

readyState: ReadyState

request

request: Request

response

response: Observable<Response> | Observable<any>

NodeJsonpBackend

NodeJsonpBackend:

constructor

new NodeJsonpBackend(_baseResponseOptions: ResponseOptions, _ngZone: NgZone, _baseUrl: string, _originUrl: string): NodeJsonpBackend

- Defined in node_modules/angular2-universal/src/node/http/node_http.ts:256
Parameters
- _baseResponseOptions: ResponseOptions
- _ngZone: NgZone
- _baseUrl: string
- _originUrl: string
Returns NodeJsonpBackend

_baseResponseOptions

_baseResponseOptions: ResponseOptions

_baseUrl

_baseUrl: string

_ngZone

_ngZone: NgZone

_originUrl

_originUrl: string

createConnection

createConnection(request: Request): NodeConnection

- Defined in node_modules/angular2-universal/src/node/http/node_http.ts:263
Parameters
- request: Request
Returns NodeConnection

JSONP_ERR_WRONG_METHOD

JSONP_ERR_WRONG_METHOD: string

"node_modules/angular2-universal/src/node/http/preload_cache"

"node_modules/angular2-universal/src/node/http/preload_cache":

NgPreloadCacheHttp

NgPreloadCacheHttp:

constructor

new NgPreloadCacheHttp(_backend: ConnectionBackend, _defaultOptions: RequestOptions, _ngZone: NgZone, prime?: boolean): NgPreloadCacheHttp

Overwrites Http.__constructor
- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:149
Parameters
- _backend: ConnectionBackend
- _defaultOptions: RequestOptions
- _ngZone: NgZone
- Optional prime: boolean
Returns NgPreloadCacheHttp

_activeNode

_activeNode: any

_async

_async: number

_backend

_backend: ConnectionBackend

_callId

_callId: number

_defaultOptions

_defaultOptions: RequestOptions

_ngZone

_ngZone: NgZone

_rootNode

_rootNode: any

prime

prime: boolean

delete

delete(url: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

Overwrites Http.delete
- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:226
Parameters
- url: string
- Optional options: RequestOptionsArgs
Returns Observable<Response> | EventEmitter<any>

get

get(url: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

Overwrites Http.get
- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:217
Parameters
- url: string
- Optional options: RequestOptionsArgs
Returns Observable<Response> | EventEmitter<any>

head

head(url: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

Overwrites Http.head
- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:232
Parameters
- url: string
- Optional options: RequestOptionsArgs
Returns Observable<Response> | EventEmitter<any>

patch

patch(url: string, body: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

Overwrites Http.patch
- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:229
Parameters
- url: string
- body: string
- Optional options: RequestOptionsArgs
Returns Observable<Response> | EventEmitter<any>

post

post(url: string, body: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

Overwrites Http.post
- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:220
Parameters
- url: string
- body: string
- Optional options: RequestOptionsArgs
Returns Observable<Response> | EventEmitter<any>

preload

preload(url: any, factory: any): EventEmitter<Object>

- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:164
Parameters
- url: any
- factory: any
Returns EventEmitter<Object>

put

put(url: string, body: string, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

Overwrites Http.put
- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:223
Parameters
- url: string
- body: string
- Optional options: RequestOptionsArgs
Returns Observable<Response> | EventEmitter<any>

request

request(url: string | Request, options?: RequestOptionsArgs): Observable<Response> | EventEmitter<any>

Overwrites Http.request
- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:213
Parameters
- url: string | Request
- Optional options: RequestOptionsArgs
Returns Observable<Response> | EventEmitter<any>

NodeXhr

NodeXhr:

constructor

new NodeXhr(baseUrl?: string): NodeXhr

- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:118
Parameters
- Optional baseUrl: string
Returns NodeXhr

_baseUrl

_baseUrl: string

build

build(): XMLHttpRequest

- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:128
Returns XMLHttpRequest

NodeXhrBackend

NodeXhrBackend:

constructor

new NodeXhrBackend(_browserXHR: BrowserXhr, _baseResponseOptions: ResponseOptions): NodeXhrBackend

- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:136
Parameters
- _browserXHR: BrowserXhr
- _baseResponseOptions: ResponseOptions
Returns NodeXhrBackend

_baseResponseOptions

_baseResponseOptions: ResponseOptions

_browserXHR

_browserXHR: BrowserXhr

createConnection

createConnection(request: any): Connection

- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:139
Parameters
- request: any
Returns Connection

NodeXhrConnection

NodeXhrConnection:

constructor

new NodeXhrConnection(req: Request, browserXHR: BrowserXhr, baseResponseOptions?: ResponseOptions): NodeXhrConnection

- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:58
Parameters
- req: Request
- browserXHR: BrowserXhr
- Optional baseResponseOptions: ResponseOptions
Returns NodeXhrConnection

readyState

readyState: ReadyState

request

request: Request

response

response: any

Response {@link EventEmitter} which emits a single {@link Response} value on load event of XMLHttpRequest.

CONST_EXPR

CONST_EXPR(v: any): any

- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:44
Parameters
- v: any
Returns any

buildBaseUrl

buildBaseUrl(url: string, existing?: boolean): any

- Defined in node_modules/angular2-universal/src/node/http/preload_cache.ts:46
Parameters
- url: string
- Optional existing: boolean
Returns any

"node_modules/angular2-universal/src/node/index"

"node_modules/angular2-universal/src/node/index":

"node_modules/angular2-universal/src/node/mock/window"

"node_modules/angular2-universal/src/node/mock/window":

methods

methods: Array<string>

readonlyAttributes

readonlyAttributes: Array<string>

replaceableAttributes

replaceableAttributes: Array<any>

unforgeableAttributes

unforgeableAttributes: Array<string>

writableAttributes

writableAttributes: Array<string>

beDefensive

beDefensive(win: any, prop: any): any

- Defined in node_modules/angular2-universal/src/node/mock/window.ts:5
Warn the developer about direct access to Window props

Parameters
- win: any
- prop: any
  
  The property being accessed
Returns any

createWindow

createWindow(fn?: Function): any

- Defined in node_modules/angular2-universal/src/node/mock/window.ts:174
Parameters
- Default value fn: Function = beDefensive
Returns any

setGlobal

setGlobal(win?: any): void

- Defined in node_modules/angular2-universal/src/node/mock/window.ts:188
Parameters
- Default value win: any = createWindow()
Returns void

"node_modules/angular2-universal/src/node/ng_preboot"

"node_modules/angular2-universal/src/node/ng_preboot":

preboot

preboot: "/Users/gctang/js/universal/modules/express-engine/node_modules/preboot/dist/src/node/preboot_node"

createPrebootCode

createPrebootCode(componentType: any | Array<any>, prebootConfig?: any): Promise<string>

- Defined in node_modules/angular2-universal/src/node/ng_preboot.ts:18
Parameters
- componentType: any | Array<any>
- Default value prebootConfig: any = {}
Returns Promise<string>

createPrebootHTML

createPrebootHTML(code: string, config?: any): string

- Defined in node_modules/angular2-universal/src/node/ng_preboot.ts:110
Parameters
- code: string
- Optional config: any
Returns string

getPrebootCSS

getPrebootCSS(min?: boolean): string

- Defined in node_modules/angular2-universal/src/node/ng_preboot.ts:35
Parameters
- Optional min: boolean
Returns string

prebootConfigDefault

prebootConfigDefault(config?: object): any

- Defined in node_modules/angular2-universal/src/node/ng_preboot.ts:6
Parameters
- Default value config: object = {}
Returns any

"node_modules/angular2-universal/src/node/node"

"node_modules/angular2-universal/src/node/node":

"node_modules/angular2-universal/src/node/pipes/index"

"node_modules/angular2-universal/src/node/pipes/index":

NODE_PIPES

NODE_PIPES: Array<any>

NODE_PLATFORM_PIPES

NODE_PLATFORM_PIPES: Array<Provider>

"node_modules/angular2-universal/src/node/pipes/node-async-pipe"

"node_modules/angular2-universal/src/node/pipes/node-async-pipe":

NodeAsyncPipe

NodeAsyncPipe:

constructor

new NodeAsyncPipe(_ref: ChangeDetectorRef): NodeAsyncPipe

Overwrites AsyncPipe.__constructor
- Defined in node_modules/angular2-universal/src/node/pipes/node-async-pipe.ts:8
Parameters
- _ref: ChangeDetectorRef
Returns NodeAsyncPipe

_latestReturnedValue

_latestReturnedValue: Object

internal

_latestValue

_latestValue: Object

internal

_obj

_obj: Observable<any> | Promise<any> | EventEmitter<any>

internal

_ref

_ref: ChangeDetectorRef

_subscription

_subscription: Object

internal

_dispose

_dispose(): void

Inherited from AsyncPipe._dispose
- Defined in node_modules/@angular/common/src/pipes/async_pipe.d.ts:41
internal

Returns void

_selectStrategy

_selectStrategy(obj: Observable<any> | Promise<any> | EventEmitter<any>): any

Inherited from AsyncPipe._selectStrategy
- Defined in node_modules/@angular/common/src/pipes/async_pipe.d.ts:39
internal

Parameters
- obj: Observable<any> | Promise<any> | EventEmitter<any>
Returns any

_subscribe

_subscribe(obj: Observable<any> | Promise<any> | EventEmitter<any>): void

Inherited from AsyncPipe._subscribe
- Defined in node_modules/@angular/common/src/pipes/async_pipe.d.ts:37
internal

Parameters
- obj: Observable<any> | Promise<any> | EventEmitter<any>
Returns void

_updateLatestValue

_updateLatestValue(async: any, value: Object): void

Inherited from AsyncPipe._updateLatestValue
- Defined in node_modules/@angular/common/src/pipes/async_pipe.d.ts:43
internal

Parameters
- async: any
- value: Object
Returns void

ngOnDestroy

ngOnDestroy(): void

Inherited from AsyncPipe.ngOnDestroy
- Defined in node_modules/@angular/common/src/pipes/async_pipe.d.ts:34
Returns void

transform

transform(obj: Observable<any> | Promise<any> | EventEmitter<any>): any

Inherited from AsyncPipe.transform
- Defined in node_modules/@angular/common/src/pipes/async_pipe.d.ts:35
Parameters
- obj: Observable<any> | Promise<any> | EventEmitter<any>
Returns any

"node_modules/angular2-universal/src/node/platform/document"

"node_modules/angular2-universal/src/node/platform/document":

DOM

DOM: any

parser

parser: unknown

serializer

serializer: unknown

treeAdapter

treeAdapter: unknown

isTag

isTag(tagName: any, node: any): boolean

- Defined in node_modules/angular2-universal/src/node/platform/document.ts:14
Parameters
- tagName: any
- node: any
Returns boolean

parseDocument

parseDocument(documentHtml: string): Object

- Defined in node_modules/angular2-universal/src/node/platform/document.ts:22
Parameters
- documentHtml: string
Returns Object

parseFragment

parseFragment(el: string): Object

- Defined in node_modules/angular2-universal/src/node/platform/document.ts:18
Parameters
- el: string
Returns Object

serializeDocument

serializeDocument(document: Object): string

- Defined in node_modules/angular2-universal/src/node/platform/document.ts:107
Parameters
- document: Object
Returns string

"node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer"

"node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer":

NodeDomRenderer

NodeDomRenderer:

constructor

new NodeDomRenderer(_rootRenderer: DomRootRenderer | any, _componentProto: RenderComponentType): NodeDomRenderer

Overwrites DomRenderer.__constructor
- Defined in node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer.ts:211
Parameters
- _rootRenderer: DomRootRenderer | any
- _componentProto: RenderComponentType
Returns NodeDomRenderer

_setBooleanAttribute

_setBooleanAttribute(renderElement: any, propertyName: any, propertyValue: any): void

- Defined in node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer.ts:276
Parameters
- renderElement: any
- propertyName: any
- propertyValue: any
Returns void

_setCheckedAttribute

_setCheckedAttribute(renderElement: any, propertyName: any, propertyValue: any): void

- Defined in node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer.ts:255
Parameters
- renderElement: any
- propertyName: any
- propertyValue: any
Returns void

_setOnOffAttribute

_setOnOffAttribute(renderElement: any, propertyName: any, propertyValue: any): void

- Defined in node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer.ts:265
Parameters
- renderElement: any
- propertyName: any
- propertyValue: any
Returns void

animateNodeEnter

animateNodeEnter(node: Node): void

Inherited from DomRenderer.animateNodeEnter
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:47
Performs animations if necessary

Parameters
- node: Node
Returns void

animateNodeLeave

animateNodeLeave(node: Node): void

Inherited from DomRenderer.animateNodeLeave
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:53
If animations are necessary, performs animations then removes the element; otherwise, it just removes the element.

Parameters
- node: Node
Returns void

attachViewAfter

attachViewAfter(node: any, viewRootNodes: any[]): void

Inherited from DomRenderer.attachViewAfter
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:31
Parameters
- node: any
- viewRootNodes: any[]
Returns void

createElement

createElement(parent: Element, name: string, debugInfo: RenderDebugInfo): Node

Inherited from DomRenderer.createElement
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:26
Parameters
- parent: Element
- name: string
- debugInfo: RenderDebugInfo
Returns Node

createTemplateAnchor

createTemplateAnchor(parentElement: any, debugInfo: RenderDebugInfo): any

Inherited from DomRenderer.createTemplateAnchor
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:28
Parameters
- parentElement: any
- debugInfo: RenderDebugInfo
Returns any

createText

createText(parentElement: any, value: string, debugInfo: RenderDebugInfo): any

Inherited from DomRenderer.createText
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:29
Parameters
- parentElement: any
- value: string
- debugInfo: RenderDebugInfo
Returns any

createViewRoot

createViewRoot(hostElement: any): any

Inherited from DomRenderer.createViewRoot
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:27
Parameters
- hostElement: any
Returns any

destroyView

destroyView(hostElement: any, viewAllNodes: any[]): void

Inherited from DomRenderer.destroyView
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:33
Parameters
- hostElement: any
- viewAllNodes: any[]
Returns void

detachView

detachView(viewRootNodes: any[]): void

Inherited from DomRenderer.detachView
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:32
Parameters
- viewRootNodes: any[]
Returns void

invokeElementMethod

invokeElementMethod(renderElement: any, methodName: string, args: any[]): void

Overwrites DomRenderer.invokeElementMethod
- Defined in node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer.ts:245
Parameters
- renderElement: any
- methodName: string
- args: any[]
Returns void

listen

listen(renderElement: any, name: string, callback: Function): Function

Inherited from DomRenderer.listen
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:34
Parameters
- renderElement: any
- name: string
- callback: Function
Returns Function

listenGlobal

listenGlobal(target: string, name: string, callback: Function): Function

Inherited from DomRenderer.listenGlobal
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:35
Parameters
- target: string
- name: string
- callback: Function
Returns Function

projectNodes

projectNodes(parentElement: any, nodes: any[]): void

Inherited from DomRenderer.projectNodes
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:30
Parameters
- parentElement: any
- nodes: any[]
Returns void

selectRootElement

selectRootElement(selectorOrNode: string | any, debugInfo: RenderDebugInfo): Element

Inherited from DomRenderer.selectRootElement
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:25
Parameters
- selectorOrNode: string | any
- debugInfo: RenderDebugInfo
Returns Element

setBindingDebugInfo

setBindingDebugInfo(renderElement: any, propertyName: string, propertyValue: string): void

Inherited from DomRenderer.setBindingDebugInfo
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:38
Parameters
- renderElement: any
- propertyName: string
- propertyValue: string
Returns void

setElementAttribute

setElementAttribute(renderElement: any, attributeName: string, attributeValue: string): void

Inherited from DomRenderer.setElementAttribute
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:37
Parameters
- renderElement: any
- attributeName: string
- attributeValue: string
Returns void

setElementClass

setElementClass(renderElement: any, className: string, isAdd: boolean): void

Inherited from DomRenderer.setElementClass
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:39
Parameters
- renderElement: any
- className: string
- isAdd: boolean
Returns void

setElementProperty

setElementProperty(renderElement: any, propertyName: string, propertyValue: any): void

Overwrites DomRenderer.setElementProperty
- Defined in node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer.ts:219
Parameters
- renderElement: any
- propertyName: string
- propertyValue: any
Returns void

setElementStyle

setElementStyle(renderElement: any, styleName: string, styleValue: string): void

Overwrites DomRenderer.setElementStyle
- Defined in node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer.ts:240
Parameters
- renderElement: any
- styleName: string
- styleValue: string
Returns void

setText

setText(renderNode: any, text: string): void

Inherited from DomRenderer.setText
- Defined in node_modules/@angular/platform-browser/src/dom/dom_renderer.d.ts:42
Parameters
- renderNode: any
- text: string
Returns void

NodeDomRootRenderer_

NodeDomRootRenderer_:

constructor

new NodeDomRootRenderer_(_document: any, _eventManager: EventManager, sharedStylesHost: DomSharedStylesHost, animate: AnimationBuilder): NodeDomRootRenderer_

Overwrites DomRootRenderer.__constructor
- Defined in node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer.ts:32
Parameters
- _document: any
- _eventManager: EventManager
- sharedStylesHost: DomSharedStylesHost
- animate: AnimationBuilder
Returns NodeDomRootRenderer_

animate

animate: AnimationBuilder

document

document: any

eventManager

eventManager: EventManager

sharedStylesHost

sharedStylesHost: DomSharedStylesHost

renderComponent

renderComponent(componentProto: RenderComponentType): Renderer

Overwrites DomRootRenderer.renderComponent
- Defined in node_modules/angular2-universal/src/node/platform/dom/node_dom_renderer.ts:37
Parameters
- componentProto: RenderComponentType
Returns Renderer

DOM

DOM: any

ATTRIBUTES

ATTRIBUTES: object

a

a: Array<string>

button

button: Array<string>

fieldset

fieldset: Array<string>

form

form: Array<string>

img

img: Array<string>

input

input: Array<string>

label

label: Array<string>

optgroup

optgroup: Array<string>

option

option: Array<string>

output

output: Array<string>

progress

progress: Array<string>

script

script: Array<string>

select

select: Array<string>

textarea

textarea: Array<string>

"node_modules/angular2-universal/src/node/platform/index"

"node_modules/angular2-universal/src/node/platform/index":

"node_modules/angular2-universal/src/node/platform/node"

"node_modules/angular2-universal/src/node/platform/node":

DOM

DOM: any

NODE_APP_COMMON_PROVIDERS

NODE_APP_COMMON_PROVIDERS: Array<any>

NODE_APP_PLATFORM

NODE_APP_PLATFORM: Array<any>

NODE_APP_PLATFORM_MARKER

NODE_APP_PLATFORM_MARKER: OpaqueToken

NODE_APP_PROVIDERS

NODE_APP_PROVIDERS: Array<any>

isRc0

isRc0: boolean

templateParser

templateParser: NodeTemplateParserRc0 | NodeTemplateParser

An array of providers that should be passed into application() when bootstrapping a component.

CONST_EXPR

CONST_EXPR(v: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node.ts:62
Parameters
- v: any
Returns any

_document

_document(): any

- Defined in node_modules/angular2-universal/src/node/platform/node.ts:86
Returns any

_exceptionHandler

_exceptionHandler(): ExceptionHandler

- Defined in node_modules/angular2-universal/src/node/platform/node.ts:82
Returns ExceptionHandler

bootstrap

bootstrap(appComponentType: Type, customAppProviders?: Array<any>, customComponentProviders?: Array<any>): Promise<ComponentRef<any>>

- Defined in node_modules/angular2-universal/src/node/platform/node.ts:131
Parameters
- appComponentType: Type
- Default value customAppProviders: Array<any> = null
- Default value customComponentProviders: Array<any> = null
Returns Promise<ComponentRef<any>>

buildNodeAppProviders

buildNodeAppProviders(document?: any, providers?: Array<any>): Array<any>

- Defined in node_modules/angular2-universal/src/node/platform/node.ts:177
Parameters
- Optional document: any
- Optional providers: Array<any>
Returns Array<any>

buildNodePlatformProviders

buildNodePlatformProviders(appComponentType: Type, providers?: Array<any>): Array<any>

- Defined in node_modules/angular2-universal/src/node/platform/node.ts:193
Parameters
- appComponentType: Type
- Optional providers: Array<any>
Returns Array<any>

buildNodeProviders

buildNodeProviders(providers?: Array<any>): Array<any>

- Defined in node_modules/angular2-universal/src/node/platform/node.ts:170
Parameters
- Optional providers: Array<any>
Returns Array<any>

buildReflector

buildReflector(): void

- Defined in node_modules/angular2-universal/src/node/platform/node.ts:166
Returns void

initNodeAdapter

initNodeAdapter(): void

- Defined in node_modules/angular2-universal/src/node/platform/node.ts:70
Returns void

"node_modules/angular2-universal/src/node/platform/node_shared_styles_host"

"node_modules/angular2-universal/src/node/platform/node_shared_styles_host":

NodeSharedStylesHost

NodeSharedStylesHost:

constructor

new NodeSharedStylesHost(): NodeSharedStylesHost

Overwrites SharedStylesHost.__constructor
- Defined in node_modules/angular2-universal/src/node/platform/node_shared_styles_host.ts:13
Returns NodeSharedStylesHost

_hostNodes

_hostNodes: Set<Node>

_styles

_styles: string[]

internal

_stylesSet

_stylesSet: Set<string>

internal

_addStylesToHost

_addStylesToHost(styles: string[], host: Node): void

- Defined in node_modules/angular2-universal/src/node/platform/node_shared_styles_host.ts:18
internal

Parameters
- styles: string[]
- host: Node
Returns void

addHost

addHost(hostNode: Node): void

- Defined in node_modules/angular2-universal/src/node/platform/node_shared_styles_host.ts:24
Parameters
- hostNode: Node
Returns void

addStyles

addStyles(styles: string[]): void

Inherited from SharedStylesHost.addStyles
- Defined in node_modules/@angular/platform-browser/src/dom/shared_styles_host.d.ts:7
Parameters
- styles: string[]
Returns void

getAllStyles

getAllStyles(): string[]

Inherited from SharedStylesHost.getAllStyles
- Defined in node_modules/@angular/platform-browser/src/dom/shared_styles_host.d.ts:9
Returns string[]

onStylesAdded

onStylesAdded(additions: string[]): void

Overwrites SharedStylesHost.onStylesAdded
- Defined in node_modules/angular2-universal/src/node/platform/node_shared_styles_host.ts:32
Parameters
- additions: string[]
Returns void

removeHost

removeHost(hostNode: Node): void

- Defined in node_modules/angular2-universal/src/node/platform/node_shared_styles_host.ts:28
Parameters
- hostNode: Node
Returns void

DOM

DOM: any

"node_modules/angular2-universal/src/node/platform/node_template_parser"

"node_modules/angular2-universal/src/node/platform/node_template_parser":

BoundElementOrDirectiveProperty

BoundElementOrDirectiveProperty:

constructor

new BoundElementOrDirectiveProperty(name: string, expression: AST, isLiteral: boolean, sourceSpan: ParseSourceSpan): BoundElementOrDirectiveProperty

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:842
Parameters
- name: string
- expression: AST
- isLiteral: boolean
- sourceSpan: ParseSourceSpan
Returns BoundElementOrDirectiveProperty

expression

expression: AST

isLiteral

isLiteral: boolean

name

sourceSpan

sourceSpan: ParseSourceSpan

ElementContext

ElementContext:

constructor

new ElementContext(isTemplateElement: boolean, _ngContentIndexMatcher: SelectorMatcher, _wildcardNgContentIndex: number, providerContext: ProviderElementContext): ElementContext

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:873
Parameters
- isTemplateElement: boolean
- _ngContentIndexMatcher: SelectorMatcher
- _wildcardNgContentIndex: number
- providerContext: ProviderElementContext
Returns ElementContext

_ngContentIndexMatcher

_ngContentIndexMatcher: SelectorMatcher

_wildcardNgContentIndex

_wildcardNgContentIndex: number

isTemplateElement

isTemplateElement: boolean

providerContext

providerContext: ProviderElementContext

findNgContentIndex

findNgContentIndex(selector: CssSelector): number

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:878
Parameters
- selector: CssSelector
Returns number

create

create(isTemplateElement: boolean, directives: DirectiveAst[], providerContext: ProviderElementContext): ElementContext

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:856
Parameters
- isTemplateElement: boolean
- directives: DirectiveAst[]
- providerContext: ProviderElementContext
Returns ElementContext

ElementOrDirectiveRef

ElementOrDirectiveRef:

constructor

new ElementOrDirectiveRef(name: string, value: string, sourceSpan: ParseSourceSpan): ElementOrDirectiveRef

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:847
Parameters
- name: string
- value: string
- sourceSpan: ParseSourceSpan
Returns ElementOrDirectiveRef

name

sourceSpan

sourceSpan: ParseSourceSpan

value

value: string

NodeTemplateParser

NodeTemplateParser:

constructor

new NodeTemplateParser(_exprParser: Parser, _schemaRegistry: ElementSchemaRegistry, _htmlParser: HtmlParser, _console: Console, transforms: TemplateAstVisitor[]): NodeTemplateParser

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:114
Parameters
- _exprParser: Parser
- _schemaRegistry: ElementSchemaRegistry
- _htmlParser: HtmlParser
- _console: Console
- transforms: TemplateAstVisitor[]
Returns NodeTemplateParser

_console

_console: Console

_exprParser

_exprParser: Parser

_htmlParser

_htmlParser: HtmlParser

_schemaRegistry

_schemaRegistry: ElementSchemaRegistry

transforms

transforms: TemplateAstVisitor[]

parse

parse(component: CompileDirectiveMetadata, template: string, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], templateUrl: string): TemplateAst[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:119
Parameters
- component: CompileDirectiveMetadata
- template: string
- directives: CompileDirectiveMetadata[]
- pipes: CompilePipeMetadata[]
- templateUrl: string
Returns TemplateAst[]

tryParse

tryParse(component: CompileDirectiveMetadata, template: string, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], templateUrl: string): TemplateParseResult

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:135
Parameters
- component: CompileDirectiveMetadata
- template: string
- directives: CompileDirectiveMetadata[]
- pipes: CompilePipeMetadata[]
- templateUrl: string
Returns TemplateParseResult

NonBindableVisitor

NonBindableVisitor:

visitAttr

visitAttr(ast: HtmlAttrAst, context: any): AttrAst

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:831
Parameters
- ast: HtmlAttrAst
- context: any
Returns AttrAst

visitComment

visitComment(ast: HtmlCommentAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:830
Parameters
- ast: HtmlCommentAst
- context: any
Returns any

visitElement

visitElement(ast: HtmlElementAst, parent: ElementContext): ElementAst

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:812
Parameters
- ast: HtmlElementAst
- parent: ElementContext
Returns ElementAst

visitExpansion

visitExpansion(ast: HtmlExpansionAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:838
Parameters
- ast: HtmlExpansionAst
- context: any
Returns any

visitExpansionCase

visitExpansionCase(ast: HtmlExpansionCaseAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:839
Parameters
- ast: HtmlExpansionCaseAst
- context: any
Returns any

visitText

visitText(ast: HtmlTextAst, parent: ElementContext): TextAst

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:834
Parameters
- ast: HtmlTextAst
- parent: ElementContext
Returns TextAst

PipeCollector

PipeCollector:

pipes

pipes: Set<string>

visitAll

visitAll(asts: AST[], context: any): any

Inherited from RecursiveAstVisitor.visitAll
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:195
Parameters
- asts: AST[]
- context: any
Returns any

visitBinary

visitBinary(ast: Binary, context: any): any

Inherited from RecursiveAstVisitor.visitBinary
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:177
Parameters
- ast: Binary
- context: any
Returns any

visitChain

visitChain(ast: Chain, context: any): any

Inherited from RecursiveAstVisitor.visitChain
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:178
Parameters
- ast: Chain
- context: any
Returns any

visitConditional

visitConditional(ast: Conditional, context: any): any

Inherited from RecursiveAstVisitor.visitConditional
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:179
Parameters
- ast: Conditional
- context: any
Returns any

visitFunctionCall

visitFunctionCall(ast: FunctionCall, context: any): any

Inherited from RecursiveAstVisitor.visitFunctionCall
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:181
Parameters
- ast: FunctionCall
- context: any
Returns any

visitImplicitReceiver

visitImplicitReceiver(ast: ImplicitReceiver, context: any): any

Inherited from RecursiveAstVisitor.visitImplicitReceiver
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:182
Parameters
- ast: ImplicitReceiver
- context: any
Returns any

visitInterpolation

visitInterpolation(ast: Interpolation, context: any): any

Inherited from RecursiveAstVisitor.visitInterpolation
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:183
Parameters
- ast: Interpolation
- context: any
Returns any

visitKeyedRead

visitKeyedRead(ast: KeyedRead, context: any): any

Inherited from RecursiveAstVisitor.visitKeyedRead
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:184
Parameters
- ast: KeyedRead
- context: any
Returns any

visitKeyedWrite

visitKeyedWrite(ast: KeyedWrite, context: any): any

Inherited from RecursiveAstVisitor.visitKeyedWrite
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:185
Parameters
- ast: KeyedWrite
- context: any
Returns any

visitLiteralArray

visitLiteralArray(ast: LiteralArray, context: any): any

Inherited from RecursiveAstVisitor.visitLiteralArray
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:186
Parameters
- ast: LiteralArray
- context: any
Returns any

visitLiteralMap

visitLiteralMap(ast: LiteralMap, context: any): any

Inherited from RecursiveAstVisitor.visitLiteralMap
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:187
Parameters
- ast: LiteralMap
- context: any
Returns any

visitLiteralPrimitive

visitLiteralPrimitive(ast: LiteralPrimitive, context: any): any

Inherited from RecursiveAstVisitor.visitLiteralPrimitive
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:188
Parameters
- ast: LiteralPrimitive
- context: any
Returns any

visitMethodCall

visitMethodCall(ast: MethodCall, context: any): any

Inherited from RecursiveAstVisitor.visitMethodCall
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:189
Parameters
- ast: MethodCall
- context: any
Returns any

visitPipe

visitPipe(ast: BindingPipe, context: any): any

Overwrites RecursiveAstVisitor.visitPipe
- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:916
Parameters
- ast: BindingPipe
- context: any
Returns any

visitPrefixNot

visitPrefixNot(ast: PrefixNot, context: any): any

Inherited from RecursiveAstVisitor.visitPrefixNot
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:190
Parameters
- ast: PrefixNot
- context: any
Returns any

visitPropertyRead

visitPropertyRead(ast: PropertyRead, context: any): any

Inherited from RecursiveAstVisitor.visitPropertyRead
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:191
Parameters
- ast: PropertyRead
- context: any
Returns any

visitPropertyWrite

visitPropertyWrite(ast: PropertyWrite, context: any): any

Inherited from RecursiveAstVisitor.visitPropertyWrite
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:192
Parameters
- ast: PropertyWrite
- context: any
Returns any

visitQuote

visitQuote(ast: Quote, context: any): any

Inherited from RecursiveAstVisitor.visitQuote
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:196
Parameters
- ast: Quote
- context: any
Returns any

visitSafeMethodCall

visitSafeMethodCall(ast: SafeMethodCall, context: any): any

Inherited from RecursiveAstVisitor.visitSafeMethodCall
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:194
Parameters
- ast: SafeMethodCall
- context: any
Returns any

visitSafePropertyRead

visitSafePropertyRead(ast: SafePropertyRead, context: any): any

Inherited from RecursiveAstVisitor.visitSafePropertyRead
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:193
Parameters
- ast: SafePropertyRead
- context: any
Returns any

TemplateParseVisitor

TemplateParseVisitor:

constructor

new TemplateParseVisitor(providerViewContext: ProviderViewContext, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], _exprParser: Parser, _schemaRegistry: ElementSchemaRegistry): TemplateParseVisitor

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:170
Parameters
- providerViewContext: ProviderViewContext
- directives: CompileDirectiveMetadata[]
- pipes: CompilePipeMetadata[]
- _exprParser: Parser
- _schemaRegistry: ElementSchemaRegistry
Returns TemplateParseVisitor

_exprParser

_exprParser: Parser

_schemaRegistry

_schemaRegistry: ElementSchemaRegistry

directivesIndex

directivesIndex: Map<CompileDirectiveMetadata, number>

errors

errors: TemplateParseError[]

ngContentCount

ngContentCount: number

pipesByName

pipesByName: Map<string, CompilePipeMetadata>

providerViewContext

providerViewContext: ProviderViewContext

selectorMatcher

selectorMatcher: SelectorMatcher

_assertAllEventsPublishedByDirectives

_assertAllEventsPublishedByDirectives(directives: DirectiveAst[], events: BoundEventAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:794
Parameters
- directives: DirectiveAst[]
- events: BoundEventAst[]
Returns void

_assertNoComponentsNorElementBindingsOnTemplate

_assertNoComponentsNorElementBindingsOnTemplate(directives: DirectiveAst[], elementProps: BoundElementPropertyAst[], sourceSpan: ParseSourceSpan): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:779
Parameters
- directives: DirectiveAst[]
- elementProps: BoundElementPropertyAst[]
- sourceSpan: ParseSourceSpan
Returns void

_assertOnlyOneComponent

_assertOnlyOneComponent(directives: DirectiveAst[], sourceSpan: ParseSourceSpan): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:772
Parameters
- directives: DirectiveAst[]
- sourceSpan: ParseSourceSpan
Returns void

_checkPipes

_checkPipes(ast: ASTWithSource, sourceSpan: ParseSourceSpan): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:250
Parameters
- ast: ASTWithSource
- sourceSpan: ParseSourceSpan
Returns void

_createDirectiveAsts

_createDirectiveAsts(isTemplateElement: boolean, elementName: string, directives: CompileDirectiveMetadata[], props: BoundElementOrDirectiveProperty[], elementOrDirectiveRefs: ElementOrDirectiveRef[], sourceSpan: ParseSourceSpan, targetReferences: ReferenceAst[]): DirectiveAst[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:592
Parameters
- isTemplateElement: boolean
- elementName: string
- directives: CompileDirectiveMetadata[]
- props: BoundElementOrDirectiveProperty[]
- elementOrDirectiveRefs: ElementOrDirectiveRef[]
- sourceSpan: ParseSourceSpan
- targetReferences: ReferenceAst[]
Returns DirectiveAst[]

_createDirectiveHostEventAsts

_createDirectiveHostEventAsts(hostListeners: object, sourceSpan: ParseSourceSpan, targetEventAsts: BoundEventAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:651
Parameters
- hostListeners: object
  - [key: string]: string
- sourceSpan: ParseSourceSpan
- targetEventAsts: BoundEventAst[]
Returns void

_createDirectiveHostPropertyAsts

_createDirectiveHostPropertyAsts(elementName: string, hostProps: object, sourceSpan: ParseSourceSpan, targetPropertyAsts: BoundElementPropertyAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:639
Parameters
- elementName: string
- hostProps: object
  - [key: string]: string
- sourceSpan: ParseSourceSpan
- targetPropertyAsts: BoundElementPropertyAst[]
Returns void

_createDirectivePropertyAsts

_createDirectivePropertyAsts(directiveProperties: object, boundProps: BoundElementOrDirectiveProperty[], targetBoundDirectiveProps: BoundDirectivePropertyAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:661
Parameters
- directiveProperties: object
  - [key: string]: string
- boundProps: BoundElementOrDirectiveProperty[]
- targetBoundDirectiveProps: BoundDirectivePropertyAst[]
Returns void

_createElementPropertyAst

_createElementPropertyAst(elementName: string, name: string, ast: AST, sourceSpan: ParseSourceSpan): BoundElementPropertyAst

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:704
Parameters
- elementName: string
- name: string
- ast: AST
- sourceSpan: ParseSourceSpan
Returns BoundElementPropertyAst

_createElementPropertyAsts

_createElementPropertyAsts(elementName: string, props: BoundElementOrDirectiveProperty[], directives: DirectiveAst[]): BoundElementPropertyAst[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:686
Parameters
- elementName: string
- props: BoundElementOrDirectiveProperty[]
- directives: DirectiveAst[]
Returns BoundElementPropertyAst[]

_findComponentDirectiveNames

_findComponentDirectiveNames(directives: DirectiveAst[]): string[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:761
Parameters
- directives: DirectiveAst[]
Returns string[]

_normalizeAttributeName

_normalizeAttributeName(attrName: string): string

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:510
Parameters
- attrName: string
Returns string

_parseAction

_parseAction(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:208
Parameters
- value: string
- sourceSpan: ParseSourceSpan
Returns ASTWithSource

_parseAssignmentEvent

_parseAssignmentEvent(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetEvents: BoundEventAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:555
Parameters
- name: string
- expression: string
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetEvents: BoundEventAst[]
Returns void

_parseAttr

_parseAttr(isTemplateElement: boolean, attr: HtmlAttrAst, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[], targetEvents: BoundEventAst[], targetRefs: ElementOrDirectiveRef[], targetVars: VariableAst[]): boolean

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:438
Parameters
- isTemplateElement: boolean
- attr: HtmlAttrAst
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
- targetEvents: BoundEventAst[]
- targetRefs: ElementOrDirectiveRef[]
- targetVars: VariableAst[]
Returns boolean

_parseBinding

_parseBinding(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:220
Parameters
- value: string
- sourceSpan: ParseSourceSpan
Returns ASTWithSource

_parseDirectives

_parseDirectives(selectorMatcher: SelectorMatcher, elementCssSelector: CssSelector): CompileDirectiveMetadata[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:580
Parameters
- selectorMatcher: SelectorMatcher
- elementCssSelector: CssSelector
Returns CompileDirectiveMetadata[]

_parseEvent

_parseEvent(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetEvents: BoundEventAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:561
Parameters
- name: string
- expression: string
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetEvents: BoundEventAst[]
Returns void

_parseInlineTemplateBinding

_parseInlineTemplateBinding(attr: HtmlAttrAst, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[], targetVars: VariableAst[]): boolean

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:409
Parameters
- attr: HtmlAttrAst
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
- targetVars: VariableAst[]
Returns boolean

_parseInterpolation

_parseInterpolation(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:191
Parameters
- value: string
- sourceSpan: ParseSourceSpan
Returns ASTWithSource

_parseLiteralAttr

_parseLiteralAttr(name: string, value: string, sourceSpan: ParseSourceSpan, targetProps: BoundElementOrDirectiveProperty[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:574
Parameters
- name: string
- value: string
- sourceSpan: ParseSourceSpan
- targetProps: BoundElementOrDirectiveProperty[]
Returns void

_parseProperty

_parseProperty(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:530
Parameters
- name: string
- expression: string
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
Returns void

_parsePropertyAst

_parsePropertyAst(name: string, ast: ASTWithSource, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:548
Parameters
- name: string
- ast: ASTWithSource
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
Returns void

_parsePropertyInterpolation

_parsePropertyInterpolation(name: string, value: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): boolean

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:537
Parameters
- name: string
- value: string
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
Returns boolean

_parseReference

_parseReference(identifier: string, value: string, sourceSpan: ParseSourceSpan, targetRefs: ElementOrDirectiveRef[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:522
Parameters
- identifier: string
- value: string
- sourceSpan: ParseSourceSpan
- targetRefs: ElementOrDirectiveRef[]
Returns void

_parseTemplateBindings

_parseTemplateBindings(value: string, sourceSpan: ParseSourceSpan): TemplateBinding[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:232
Parameters
- value: string
- sourceSpan: ParseSourceSpan
Returns TemplateBinding[]

_parseVariable

_parseVariable(identifier: string, value: string, sourceSpan: ParseSourceSpan, targetVars: VariableAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:514
Parameters
- identifier: string
- value: string
- sourceSpan: ParseSourceSpan
- targetVars: VariableAst[]
Returns void

_reportError

_reportError(message: string, sourceSpan: ParseSourceSpan, level?: ParseErrorLevel): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:186
Parameters
- message: string
- sourceSpan: ParseSourceSpan
- Default value level: ParseErrorLevel = ParseErrorLevel.FATAL
Returns void

visitAttr

visitAttr(ast: HtmlAttrAst, contex: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:276
Parameters
- ast: HtmlAttrAst
- contex: any
Returns any

visitComment

visitComment(ast: HtmlCommentAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:280
Parameters
- ast: HtmlCommentAst
- context: any
Returns any

visitElement

visitElement(element: HtmlElementAst, parent: ElementContext): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:282
Parameters
- element: HtmlElementAst
- parent: ElementContext
Returns any

visitExpansion

visitExpansion(ast: HtmlExpansionAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:262
Parameters
- ast: HtmlExpansionAst
- context: any
Returns any

visitExpansionCase

visitExpansionCase(ast: HtmlExpansionCaseAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:264
Parameters
- ast: HtmlExpansionCaseAst
- context: any
Returns any

visitText

visitText(ast: HtmlTextAst, parent: ElementContext): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:266
Parameters
- ast: HtmlTextAst
- parent: ElementContext
Returns any

ATTRIBUTE_PREFIX

ATTRIBUTE_PREFIX: string

BIND_NAME_REGEXP

BIND_NAME_REGEXP: RegExp

CLASS_ATTR

CLASS_ATTR: string

CLASS_PREFIX

CLASS_PREFIX: string

Console

Console: Console

EMPTY_ELEMENT_CONTEXT

EMPTY_ELEMENT_CONTEXT: ElementContext

MAX_INTERPOLATION_VALUES

MAX_INTERPOLATION_VALUES: number

NON_BINDABLE_VISITOR

NON_BINDABLE_VISITOR: NonBindableVisitor

PROPERTY_PARTS_SEPARATOR

PROPERTY_PARTS_SEPARATOR: string

STYLE_PREFIX

STYLE_PREFIX: string

SecurityContext

SecurityContext: SecurityContext

TEMPLATE_ATTR

TEMPLATE_ATTR: string

TEMPLATE_ATTR_PREFIX

TEMPLATE_ATTR_PREFIX: string

TEMPLATE_ELEMENT

TEMPLATE_ELEMENT: string

TEXT_CSS_SELECTOR

TEXT_CSS_SELECTOR: CssSelector

createElementCssSelector

createElementCssSelector(elementName: string, matchableAttrs: string[]): CssSelector

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:890
Parameters
- elementName: string
- matchableAttrs: string[]
Returns CssSelector

removeDuplicates

removeDuplicates(items: CompileMetadataWithType[]): CompileMetadataWithType[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:924
Parameters
- items: CompileMetadataWithType[]
Returns CompileMetadataWithType[]

splitClasses

splitClasses(classAttrValue: string): string[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser.ts:851
Parameters
- classAttrValue: string
Returns string[]

"node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0"

"node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0":

BoundElementOrDirectiveProperty

BoundElementOrDirectiveProperty:

constructor

new BoundElementOrDirectiveProperty(name: string, expression: AST, isLiteral: boolean, sourceSpan: ParseSourceSpan): BoundElementOrDirectiveProperty

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:827
Parameters
- name: string
- expression: AST
- isLiteral: boolean
- sourceSpan: ParseSourceSpan
Returns BoundElementOrDirectiveProperty

expression

expression: AST

isLiteral

isLiteral: boolean

name

sourceSpan

sourceSpan: ParseSourceSpan

ElementContext

ElementContext:

constructor

new ElementContext(isTemplateElement: boolean, _ngContentIndexMatcher: SelectorMatcher, _wildcardNgContentIndex: number, providerContext: ProviderElementContext): ElementContext

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:858
Parameters
- isTemplateElement: boolean
- _ngContentIndexMatcher: SelectorMatcher
- _wildcardNgContentIndex: number
- providerContext: ProviderElementContext
Returns ElementContext

_ngContentIndexMatcher

_ngContentIndexMatcher: SelectorMatcher

_wildcardNgContentIndex

_wildcardNgContentIndex: number

isTemplateElement

isTemplateElement: boolean

providerContext

providerContext: ProviderElementContext

findNgContentIndex

findNgContentIndex(selector: CssSelector): number

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:863
Parameters
- selector: CssSelector
Returns number

create

create(isTemplateElement: boolean, directives: DirectiveAst[], providerContext: ProviderElementContext): ElementContext

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:841
Parameters
- isTemplateElement: boolean
- directives: DirectiveAst[]
- providerContext: ProviderElementContext
Returns ElementContext

ElementOrDirectiveRef

ElementOrDirectiveRef:

constructor

new ElementOrDirectiveRef(name: string, value: string, sourceSpan: ParseSourceSpan): ElementOrDirectiveRef

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:832
Parameters
- name: string
- value: string
- sourceSpan: ParseSourceSpan
Returns ElementOrDirectiveRef

name

sourceSpan

sourceSpan: ParseSourceSpan

value

value: string

NodeTemplateParserRc0

NodeTemplateParserRc0:

constructor

new NodeTemplateParserRc0(_exprParser: Parser, _schemaRegistry: ElementSchemaRegistry, _htmlParser: HtmlParser, _console: Console, transforms: TemplateAstVisitor[]): NodeTemplateParserRc0

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:116
Parameters
- _exprParser: Parser
- _schemaRegistry: ElementSchemaRegistry
- _htmlParser: HtmlParser
- _console: Console
- transforms: TemplateAstVisitor[]
Returns NodeTemplateParserRc0

_console

_console: Console

_exprParser

_exprParser: Parser

_htmlParser

_htmlParser: HtmlParser

_schemaRegistry

_schemaRegistry: ElementSchemaRegistry

transforms

transforms: TemplateAstVisitor[]

parse

parse(component: CompileDirectiveMetadata, template: string, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], templateUrl: string): TemplateAst[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:121
Parameters
- component: CompileDirectiveMetadata
- template: string
- directives: CompileDirectiveMetadata[]
- pipes: CompilePipeMetadata[]
- templateUrl: string
Returns TemplateAst[]

tryParse

tryParse(component: CompileDirectiveMetadata, template: string, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], templateUrl: string): TemplateParseResult

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:137
Parameters
- component: CompileDirectiveMetadata
- template: string
- directives: CompileDirectiveMetadata[]
- pipes: CompilePipeMetadata[]
- templateUrl: string
Returns TemplateParseResult

NonBindableVisitor

NonBindableVisitor:

visitAttr

visitAttr(ast: HtmlAttrAst, context: any): AttrAst

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:816
Parameters
- ast: HtmlAttrAst
- context: any
Returns AttrAst

visitComment

visitComment(ast: HtmlCommentAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:815
Parameters
- ast: HtmlCommentAst
- context: any
Returns any

visitElement

visitElement(ast: HtmlElementAst, parent: ElementContext): ElementAst

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:797
Parameters
- ast: HtmlElementAst
- parent: ElementContext
Returns ElementAst

visitExpansion

visitExpansion(ast: HtmlExpansionAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:823
Parameters
- ast: HtmlExpansionAst
- context: any
Returns any

visitExpansionCase

visitExpansionCase(ast: HtmlExpansionCaseAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:824
Parameters
- ast: HtmlExpansionCaseAst
- context: any
Returns any

visitText

visitText(ast: HtmlTextAst, parent: ElementContext): TextAst

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:819
Parameters
- ast: HtmlTextAst
- parent: ElementContext
Returns TextAst

PipeCollector

PipeCollector:

pipes

pipes: Set<string>

visitAll

visitAll(asts: AST[], context: any): any

Inherited from RecursiveAstVisitor.visitAll
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:195
Parameters
- asts: AST[]
- context: any
Returns any

visitBinary

visitBinary(ast: Binary, context: any): any

Inherited from RecursiveAstVisitor.visitBinary
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:177
Parameters
- ast: Binary
- context: any
Returns any

visitChain

visitChain(ast: Chain, context: any): any

Inherited from RecursiveAstVisitor.visitChain
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:178
Parameters
- ast: Chain
- context: any
Returns any

visitConditional

visitConditional(ast: Conditional, context: any): any

Inherited from RecursiveAstVisitor.visitConditional
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:179
Parameters
- ast: Conditional
- context: any
Returns any

visitFunctionCall

visitFunctionCall(ast: FunctionCall, context: any): any

Inherited from RecursiveAstVisitor.visitFunctionCall
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:181
Parameters
- ast: FunctionCall
- context: any
Returns any

visitImplicitReceiver

visitImplicitReceiver(ast: ImplicitReceiver, context: any): any

Inherited from RecursiveAstVisitor.visitImplicitReceiver
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:182
Parameters
- ast: ImplicitReceiver
- context: any
Returns any

visitInterpolation

visitInterpolation(ast: Interpolation, context: any): any

Inherited from RecursiveAstVisitor.visitInterpolation
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:183
Parameters
- ast: Interpolation
- context: any
Returns any

visitKeyedRead

visitKeyedRead(ast: KeyedRead, context: any): any

Inherited from RecursiveAstVisitor.visitKeyedRead
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:184
Parameters
- ast: KeyedRead
- context: any
Returns any

visitKeyedWrite

visitKeyedWrite(ast: KeyedWrite, context: any): any

Inherited from RecursiveAstVisitor.visitKeyedWrite
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:185
Parameters
- ast: KeyedWrite
- context: any
Returns any

visitLiteralArray

visitLiteralArray(ast: LiteralArray, context: any): any

Inherited from RecursiveAstVisitor.visitLiteralArray
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:186
Parameters
- ast: LiteralArray
- context: any
Returns any

visitLiteralMap

visitLiteralMap(ast: LiteralMap, context: any): any

Inherited from RecursiveAstVisitor.visitLiteralMap
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:187
Parameters
- ast: LiteralMap
- context: any
Returns any

visitLiteralPrimitive

visitLiteralPrimitive(ast: LiteralPrimitive, context: any): any

Inherited from RecursiveAstVisitor.visitLiteralPrimitive
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:188
Parameters
- ast: LiteralPrimitive
- context: any
Returns any

visitMethodCall

visitMethodCall(ast: MethodCall, context: any): any

Inherited from RecursiveAstVisitor.visitMethodCall
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:189
Parameters
- ast: MethodCall
- context: any
Returns any

visitPipe

visitPipe(ast: BindingPipe, context: any): any

Overwrites RecursiveAstVisitor.visitPipe
- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:901
Parameters
- ast: BindingPipe
- context: any
Returns any

visitPrefixNot

visitPrefixNot(ast: PrefixNot, context: any): any

Inherited from RecursiveAstVisitor.visitPrefixNot
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:190
Parameters
- ast: PrefixNot
- context: any
Returns any

visitPropertyRead

visitPropertyRead(ast: PropertyRead, context: any): any

Inherited from RecursiveAstVisitor.visitPropertyRead
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:191
Parameters
- ast: PropertyRead
- context: any
Returns any

visitPropertyWrite

visitPropertyWrite(ast: PropertyWrite, context: any): any

Inherited from RecursiveAstVisitor.visitPropertyWrite
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:192
Parameters
- ast: PropertyWrite
- context: any
Returns any

visitQuote

visitQuote(ast: Quote, context: any): any

Inherited from RecursiveAstVisitor.visitQuote
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:196
Parameters
- ast: Quote
- context: any
Returns any

visitSafeMethodCall

visitSafeMethodCall(ast: SafeMethodCall, context: any): any

Inherited from RecursiveAstVisitor.visitSafeMethodCall
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:194
Parameters
- ast: SafeMethodCall
- context: any
Returns any

visitSafePropertyRead

visitSafePropertyRead(ast: SafePropertyRead, context: any): any

Inherited from RecursiveAstVisitor.visitSafePropertyRead
- Defined in node_modules/@angular/compiler/src/expression_parser/ast.d.ts:193
Parameters
- ast: SafePropertyRead
- context: any
Returns any

TemplateParseVisitor

TemplateParseVisitor:

constructor

new TemplateParseVisitor(providerViewContext: ProviderViewContext, directives: CompileDirectiveMetadata[], pipes: CompilePipeMetadata[], _exprParser: Parser, _schemaRegistry: ElementSchemaRegistry): TemplateParseVisitor

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:172
Parameters
- providerViewContext: ProviderViewContext
- directives: CompileDirectiveMetadata[]
- pipes: CompilePipeMetadata[]
- _exprParser: Parser
- _schemaRegistry: ElementSchemaRegistry
Returns TemplateParseVisitor

_exprParser

_exprParser: Parser

_schemaRegistry

_schemaRegistry: ElementSchemaRegistry

directivesIndex

directivesIndex: Map<CompileDirectiveMetadata, number>

errors

errors: TemplateParseError[]

ngContentCount

ngContentCount: number

pipesByName

pipesByName: Map<string, CompilePipeMetadata>

providerViewContext

providerViewContext: ProviderViewContext

selectorMatcher

selectorMatcher: SelectorMatcher

_assertAllEventsPublishedByDirectives

_assertAllEventsPublishedByDirectives(directives: DirectiveAst[], events: BoundEventAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:779
Parameters
- directives: DirectiveAst[]
- events: BoundEventAst[]
Returns void

_assertNoComponentsNorElementBindingsOnTemplate

_assertNoComponentsNorElementBindingsOnTemplate(directives: DirectiveAst[], elementProps: BoundElementPropertyAst[], sourceSpan: ParseSourceSpan): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:764
Parameters
- directives: DirectiveAst[]
- elementProps: BoundElementPropertyAst[]
- sourceSpan: ParseSourceSpan
Returns void

_assertOnlyOneComponent

_assertOnlyOneComponent(directives: DirectiveAst[], sourceSpan: ParseSourceSpan): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:757
Parameters
- directives: DirectiveAst[]
- sourceSpan: ParseSourceSpan
Returns void

_checkPipes

_checkPipes(ast: ASTWithSource, sourceSpan: ParseSourceSpan): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:252
Parameters
- ast: ASTWithSource
- sourceSpan: ParseSourceSpan
Returns void

_createDirectiveAsts

_createDirectiveAsts(isTemplateElement: boolean, elementName: string, directives: CompileDirectiveMetadata[], props: BoundElementOrDirectiveProperty[], elementOrDirectiveRefs: ElementOrDirectiveRef[], sourceSpan: ParseSourceSpan, targetReferences: ReferenceAst[]): DirectiveAst[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:591
Parameters
- isTemplateElement: boolean
- elementName: string
- directives: CompileDirectiveMetadata[]
- props: BoundElementOrDirectiveProperty[]
- elementOrDirectiveRefs: ElementOrDirectiveRef[]
- sourceSpan: ParseSourceSpan
- targetReferences: ReferenceAst[]
Returns DirectiveAst[]

_createDirectiveHostEventAsts

_createDirectiveHostEventAsts(hostListeners: object, sourceSpan: ParseSourceSpan, targetEventAsts: BoundEventAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:650
Parameters
- hostListeners: object
  - [key: string]: string
- sourceSpan: ParseSourceSpan
- targetEventAsts: BoundEventAst[]
Returns void

_createDirectiveHostPropertyAsts

_createDirectiveHostPropertyAsts(elementName: string, hostProps: object, sourceSpan: ParseSourceSpan, targetPropertyAsts: BoundElementPropertyAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:638
Parameters
- elementName: string
- hostProps: object
  - [key: string]: string
- sourceSpan: ParseSourceSpan
- targetPropertyAsts: BoundElementPropertyAst[]
Returns void

_createDirectivePropertyAsts

_createDirectivePropertyAsts(directiveProperties: object, boundProps: BoundElementOrDirectiveProperty[], targetBoundDirectiveProps: BoundDirectivePropertyAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:660
Parameters
- directiveProperties: object
  - [key: string]: string
- boundProps: BoundElementOrDirectiveProperty[]
- targetBoundDirectiveProps: BoundDirectivePropertyAst[]
Returns void

_createElementPropertyAst

_createElementPropertyAst(elementName: string, name: string, ast: AST, sourceSpan: ParseSourceSpan): BoundElementPropertyAst

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:703
Parameters
- elementName: string
- name: string
- ast: AST
- sourceSpan: ParseSourceSpan
Returns BoundElementPropertyAst

_createElementPropertyAsts

_createElementPropertyAsts(elementName: string, props: BoundElementOrDirectiveProperty[], directives: DirectiveAst[]): BoundElementPropertyAst[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:685
Parameters
- elementName: string
- props: BoundElementOrDirectiveProperty[]
- directives: DirectiveAst[]
Returns BoundElementPropertyAst[]

_findComponentDirectiveNames

_findComponentDirectiveNames(directives: DirectiveAst[]): string[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:746
Parameters
- directives: DirectiveAst[]
Returns string[]

_normalizeAttributeName

_normalizeAttributeName(attrName: string): string

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:509
Parameters
- attrName: string
Returns string

_parseAction

_parseAction(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:210
Parameters
- value: string
- sourceSpan: ParseSourceSpan
Returns ASTWithSource

_parseAssignmentEvent

_parseAssignmentEvent(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetEvents: BoundEventAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:554
Parameters
- name: string
- expression: string
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetEvents: BoundEventAst[]
Returns void

_parseAttr

_parseAttr(isTemplateElement: boolean, attr: HtmlAttrAst, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[], targetEvents: BoundEventAst[], targetRefs: ElementOrDirectiveRef[], targetVars: VariableAst[]): boolean

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:437
Parameters
- isTemplateElement: boolean
- attr: HtmlAttrAst
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
- targetEvents: BoundEventAst[]
- targetRefs: ElementOrDirectiveRef[]
- targetVars: VariableAst[]
Returns boolean

_parseBinding

_parseBinding(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:222
Parameters
- value: string
- sourceSpan: ParseSourceSpan
Returns ASTWithSource

_parseDirectives

_parseDirectives(selectorMatcher: SelectorMatcher, elementCssSelector: CssSelector): CompileDirectiveMetadata[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:579
Parameters
- selectorMatcher: SelectorMatcher
- elementCssSelector: CssSelector
Returns CompileDirectiveMetadata[]

_parseEvent

_parseEvent(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetEvents: BoundEventAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:560
Parameters
- name: string
- expression: string
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetEvents: BoundEventAst[]
Returns void

_parseInlineTemplateBinding

_parseInlineTemplateBinding(attr: HtmlAttrAst, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[], targetVars: VariableAst[]): boolean

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:408
Parameters
- attr: HtmlAttrAst
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
- targetVars: VariableAst[]
Returns boolean

_parseInterpolation

_parseInterpolation(value: string, sourceSpan: ParseSourceSpan): ASTWithSource

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:193
Parameters
- value: string
- sourceSpan: ParseSourceSpan
Returns ASTWithSource

_parseLiteralAttr

_parseLiteralAttr(name: string, value: string, sourceSpan: ParseSourceSpan, targetProps: BoundElementOrDirectiveProperty[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:573
Parameters
- name: string
- value: string
- sourceSpan: ParseSourceSpan
- targetProps: BoundElementOrDirectiveProperty[]
Returns void

_parseProperty

_parseProperty(name: string, expression: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:529
Parameters
- name: string
- expression: string
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
Returns void

_parsePropertyAst

_parsePropertyAst(name: string, ast: ASTWithSource, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:547
Parameters
- name: string
- ast: ASTWithSource
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
Returns void

_parsePropertyInterpolation

_parsePropertyInterpolation(name: string, value: string, sourceSpan: ParseSourceSpan, targetMatchableAttrs: string[], targetProps: BoundElementOrDirectiveProperty[]): boolean

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:536
Parameters
- name: string
- value: string
- sourceSpan: ParseSourceSpan
- targetMatchableAttrs: string[]
- targetProps: BoundElementOrDirectiveProperty[]
Returns boolean

_parseReference

_parseReference(identifier: string, value: string, sourceSpan: ParseSourceSpan, targetRefs: ElementOrDirectiveRef[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:521
Parameters
- identifier: string
- value: string
- sourceSpan: ParseSourceSpan
- targetRefs: ElementOrDirectiveRef[]
Returns void

_parseTemplateBindings

_parseTemplateBindings(value: string, sourceSpan: ParseSourceSpan): TemplateBinding[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:234
Parameters
- value: string
- sourceSpan: ParseSourceSpan
Returns TemplateBinding[]

_parseVariable

_parseVariable(identifier: string, value: string, sourceSpan: ParseSourceSpan, targetVars: VariableAst[]): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:513
Parameters
- identifier: string
- value: string
- sourceSpan: ParseSourceSpan
- targetVars: VariableAst[]
Returns void

_reportError

_reportError(message: string, sourceSpan: ParseSourceSpan, level?: ParseErrorLevel): void

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:188
Parameters
- message: string
- sourceSpan: ParseSourceSpan
- Default value level: ParseErrorLevel = ParseErrorLevel.FATAL
Returns void

visitAttr

visitAttr(ast: HtmlAttrAst, contex: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:278
Parameters
- ast: HtmlAttrAst
- contex: any
Returns any

visitComment

visitComment(ast: HtmlCommentAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:282
Parameters
- ast: HtmlCommentAst
- context: any
Returns any

visitElement

visitElement(element: HtmlElementAst, parent: ElementContext): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:284
Parameters
- element: HtmlElementAst
- parent: ElementContext
Returns any

visitExpansion

visitExpansion(ast: HtmlExpansionAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:264
Parameters
- ast: HtmlExpansionAst
- context: any
Returns any

visitExpansionCase

visitExpansionCase(ast: HtmlExpansionCaseAst, context: any): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:266
Parameters
- ast: HtmlExpansionCaseAst
- context: any
Returns any

visitText

visitText(ast: HtmlTextAst, parent: ElementContext): any

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:268
Parameters
- ast: HtmlTextAst
- parent: ElementContext
Returns any

ATTRIBUTE_PREFIX

ATTRIBUTE_PREFIX: string

BIND_NAME_REGEXP

BIND_NAME_REGEXP: RegExp

CLASS_ATTR

CLASS_ATTR: string

CLASS_PREFIX

CLASS_PREFIX: string

Console

Console: Console

EMPTY_ELEMENT_CONTEXT

EMPTY_ELEMENT_CONTEXT: ElementContext

MAX_INTERPOLATION_VALUES

MAX_INTERPOLATION_VALUES: number

NON_BINDABLE_VISITOR

NON_BINDABLE_VISITOR: NonBindableVisitor

PROPERTY_PARTS_SEPARATOR

PROPERTY_PARTS_SEPARATOR: string

STYLE_PREFIX

STYLE_PREFIX: string

SecurityContext

SecurityContext: SecurityContext

TEMPLATE_ATTR

TEMPLATE_ATTR: string

TEMPLATE_ATTR_PREFIX

TEMPLATE_ATTR_PREFIX: string

TEMPLATE_ELEMENT

TEMPLATE_ELEMENT: string

TEXT_CSS_SELECTOR

TEXT_CSS_SELECTOR: CssSelector

createElementCssSelector

createElementCssSelector(elementName: string, matchableAttrs: string[]): CssSelector

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:875
Parameters
- elementName: string
- matchableAttrs: string[]
Returns CssSelector

removeDuplicates

removeDuplicates(items: CompileMetadataWithType[]): CompileMetadataWithType[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:909
Parameters
- items: CompileMetadataWithType[]
Returns CompileMetadataWithType[]

splitClasses

splitClasses(classAttrValue: string): string[]

- Defined in node_modules/angular2-universal/src/node/platform/node_template_parser-rc.0.ts:836
Parameters
- classAttrValue: string
Returns string[]

"node_modules/angular2-universal/src/node/platform/node_xhr_impl"

"node_modules/angular2-universal/src/node/platform/node_xhr_impl":

NodeXHRImpl

NodeXHRImpl:

constructor

new NodeXHRImpl(ngZone: NgZone, _originUrl?: string, _baseUrl?: string): NodeXHRImpl

- Defined in node_modules/angular2-universal/src/node/platform/node_xhr_impl.ts:11
Parameters
- ngZone: NgZone
- Default value _originUrl: string = ""
- Optional _baseUrl: string
Returns NodeXHRImpl

_baseUrl

_baseUrl: string

_originUrl

_originUrl: string

ngZone

ngZone: NgZone

get

get(templateUrl: string): Promise<string>

Overwrites XHR.get
- Defined in node_modules/angular2-universal/src/node/platform/node_xhr_impl.ts:20
Parameters
- templateUrl: string
Returns Promise<string>

"node_modules/angular2-universal/src/node/render"

"node_modules/angular2-universal/src/node/render":

appRefSyncRender

appRefSyncRender(appRef: any): string

- Defined in node_modules/angular2-universal/src/node/render.ts:88
Parameters
- appRef: any
Returns string

applicationToString

applicationToString(appRef: ComponentRef<any>): string

- Defined in node_modules/angular2-universal/src/node/render.ts:102
Parameters
- appRef: ComponentRef<any>
Returns string

renderDocument

renderDocument(documentHtml: string, componentType: Type, nodeProviders?: any): Promise<string>

- Defined in node_modules/angular2-universal/src/node/render.ts:41
Parameters
- documentHtml: string
- componentType: Type
- Optional nodeProviders: any
Returns Promise<string>

renderDocumentWithPreboot

renderDocumentWithPreboot(documentHtml: string, componentType: Type, nodeProviders?: any, prebootConfig?: any): Promise<string>

- Defined in node_modules/angular2-universal/src/node/render.ts:59
Parameters
- documentHtml: string
- componentType: Type
- Optional nodeProviders: any
- Default value prebootConfig: any = {}
Returns Promise<string>

renderToString

renderToString(componentType: any, nodeProviders?: any): Promise<string>

- Defined in node_modules/angular2-universal/src/node/render.ts:110
Parameters
- componentType: any
- Optional nodeProviders: any
Returns Promise<string>

renderToStringWithPreboot

renderToStringWithPreboot(componentType: any, nodeProviders?: any, prebootConfig?: any): Promise<string>

- Defined in node_modules/angular2-universal/src/node/render.ts:116
Parameters
- componentType: any
- Optional nodeProviders: any
- Default value prebootConfig: any = {}
Returns Promise<string>

serializeApplication

serializeApplication(element: any, styles: string[], cache?: any): string

- Defined in node_modules/angular2-universal/src/node/render.ts:70
Parameters
- element: any
- styles: string[]
- Optional cache: any
Returns string

waitRouter

waitRouter(appRef: ComponentRef<any>): Promise<ComponentRef<any>>

- Defined in node_modules/angular2-universal/src/node/render.ts:33
Parameters
- appRef: ComponentRef<any>
Returns Promise<ComponentRef<any>>

"node_modules/angular2-universal/src/node/router/index"

"node_modules/angular2-universal/src/node/router/index":

NODE_LOCATION_PROVIDERS

NODE_LOCATION_PROVIDERS: Array<any>

NODE_ROUTER_PROVIDERS

NODE_ROUTER_PROVIDERS: Array<any>

"node_modules/angular2-universal/src/node/router/node_platform_location"

"node_modules/angular2-universal/src/node/router/node_platform_location":

NodeLocation

NodeLocation:

constructor

new NodeLocation(config: NodeLocationConfig & LocationConfig): NodeLocation

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:36
Parameters
- config: NodeLocationConfig & LocationConfig
Returns NodeLocation

hash

hash: string

host

host: string

hostname

hostname: string

href

href: string

pathname

pathname: string

port

port: string

protocol

protocol: string

search

search: string

origin

origin:

assign

assign(parsed: NodeLocationConfig):

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:46
Parameters
- parsed: NodeLocationConfig
Returns

format

format(obj: NodeLocationConfig): string

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:43
Parameters
- obj: NodeLocationConfig
Returns string

parse

parse(url: string): Url

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:40
Parameters
- url: string
Returns Url

NodePlatformLocation

NodePlatformLocation:

constructor

new NodePlatformLocation(originUrl: string, requestUrl: string, baseUrl?: string): NodePlatformLocation

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:107
Parameters
- originUrl: string
- requestUrl: string
- Optional baseUrl: string
Returns NodePlatformLocation

_baseUrl

_baseUrl: string

_loc

_loc: LocationConfig

_originUrl

_originUrl: string

_popStateListeners

_popStateListeners: Array<Function>

_stack

_stack: Array<State>

_stackIndex

_stackIndex: number

hash

hash:

pathname

pathname:

search

search:

_callPopStateListeners

_callPopStateListeners(): void

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:197
Returns void

_setLocationByUrl

_setLocationByUrl(url: string): void

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:190
Parameters
- url: string
Returns void

_updateLocation

_updateLocation(): void

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:183
Returns void

back

back(): void

Overwrites PlatformLocation.back
- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:149
Returns void

forward

forward(): void

Overwrites PlatformLocation.forward
- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:159
Returns void

getBaseHref

getBaseHref(): string

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:131
Returns string

getBaseHrefFromDOM

getBaseHrefFromDOM(): string

Overwrites PlatformLocation.getBaseHrefFromDOM
- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:124
Returns string

onHashChange

onHashChange(fn: any): void

Overwrites PlatformLocation.onHashChange
- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:147
Parameters
- fn: any
Returns void

onPopState

onPopState(fn: any): void

Overwrites PlatformLocation.onPopState
- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:146
Parameters
- fn: any
Returns void

path

path(): string

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:133
Returns string

prepareExternalUrl

prepareExternalUrl(internal: string): string

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:169
Parameters
- internal: string
Returns string

pushState

pushState(state: any, title: string, url: string): void

Overwrites PlatformLocation.pushState
- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:135
Parameters
- state: any
- title: string
- url: string
Returns void

replaceState

replaceState(state: any, title: string, url: string): void

Overwrites PlatformLocation.replaceState
- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:141
Parameters
- state: any
- title: string
- url: string
Returns void

toJSON

toJSON(): any

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:173
Returns any

PopStateEvent

PopStateEvent:

constructor

new PopStateEvent(state: any): PopStateEvent

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:89
Parameters
- state: any
Returns PopStateEvent

state

state: any

type

type: string

toJSON

toJSON(): object

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:92
Returns object
- state: any

State

State:

constructor

new State(state: any, title: string, url: string): State

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:73
Parameters
- state: any
- title: string
- url: string
Returns State

state

state: any

title

title: string

url

url: string

toJSON

toJSON(): object

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:79
Returns object
- state: any
- title: string
- url: string

LocationConfig

LocationConfig:

hash

hash: string

pathname

pathname: string

search

search: string

NodeLocationConfig

NodeLocationConfig:

hash

hash: string

host

host: string

hostname

hostname: string

href

href: string

pathname

pathname: string

port

port: string

protocol

protocol: string

search

search: string

joinWithSlash

joinWithSlash(start: string, end: string): string

- Defined in node_modules/angular2-universal/src/node/router/node_platform_location.ts:208
Parameters
- start: string
- end: string
Returns string

config

config: object

hash

hash: any

host

host: any

hostname

hostname: any

href

href: any

pathname

pathname: any

port

port: any

protocol

protocol: any

search

search: any

"node_modules/angular2-universal/src/node/stringify_element"

"node_modules/angular2-universal/src/node/stringify_element":

DOM

DOM: any

_singleTagWhitelist

_singleTagWhitelist: Array<string>

stringifyElement

stringifyElement(el: any): string

- Defined in node_modules/angular2-universal/src/node/stringify_element.ts:12
Parameters
- el: any
Returns string

"node_modules/angular2-universal/src/node/test/router/node_platform_location.spec"

"node_modules/angular2-universal/src/node/test/router/node_platform_location.spec":

jasmine

jasmine: any

back

back(spl: NodePlatformLocation, steps: any): void

- Defined in node_modules/angular2-universal/src/node/test/router/node_platform_location.spec.ts:32
Parameters
- spl: NodePlatformLocation
- steps: any
Returns void

expectProperties

expectProperties(spl: NodePlatformLocation, props: any): void

- Defined in node_modules/angular2-universal/src/node/test/router/node_platform_location.spec.ts:21
Parameters
- spl: NodePlatformLocation
- props: any
Returns void

forward

forward(spl: NodePlatformLocation, steps: any): void

- Defined in node_modules/angular2-universal/src/node/test/router/node_platform_location.spec.ts:36
Parameters
- spl: NodePlatformLocation
- steps: any
Returns void

normalizeProperties

normalizeProperties(__namedParameters: object): object

- Defined in node_modules/angular2-universal/src/node/test/router/node_platform_location.spec.ts:10
Parameters
- __namedParameters: object
  - hash: any
  - pathname: any
  - search: any
Returns object
- hash: any
- pathname: any
- search: any

"node_modules/angular2-universal/src/polyfills"

"node_modules/angular2-universal/src/polyfills":

"node_modules/angular2-universal/src/typings"

"node_modules/angular2-universal/src/typings":

"node_modules/preboot/src/browser/app_manager"

"node_modules/preboot/src/browser/app_manager":

nodeCache

nodeCache: object

Type declaration

state

state: GlobalState

addApp

addApp(appRoot: string, options: PrebootOptions): object

- Defined in node_modules/preboot/src/browser/app_manager.ts:29
Parameters
- appRoot: string
- options: PrebootOptions
Returns object
- appRoot: null
- appRootName: string
- body: null
- canComplete: boolean
- clientRoot: null
- completeCalled: boolean
- document: null
- freeze: null
- opts: PrebootOptions
- serverRoot: null
- started: boolean
- window: null

addNodeToBody

addNodeToBody(app: AppState, type: string, className: string, styles: Object): Element

- Defined in node_modules/preboot/src/browser/app_manager.ts:128
Create a new element

Parameters
- app: AppState
- type: string
- className: string
- styles: Object
Returns Element

appContains

appContains(app: AppState, node: Element): any

- Defined in node_modules/preboot/src/browser/app_manager.ts:121
Check to see if the app contains a particular node

Parameters
- app: AppState
- node: Element
Returns any

dispatchGlobalEvent

dispatchGlobalEvent(app: AppState, eventName: string): void

- Defined in node_modules/preboot/src/browser/app_manager.ts:107
Dispatch an event on the document

Parameters
- app: AppState
- eventName: string
Returns void

dispatchNodeEvent

dispatchNodeEvent(app: AppState, node: Element, eventName: string): void

- Defined in node_modules/preboot/src/browser/app_manager.ts:114
Dispatch an event on a specific node

Parameters
- app: AppState
- node: Element
- eventName: string
Returns void

findClientNode

findClientNode(app: AppState, serverNode: Element, nodeKey?: any): Element

- Defined in node_modules/preboot/src/browser/app_manager.ts:235
Given a node from the server rendered view, find the equivalent node in the client rendered view.

Parameters
- app: AppState
- serverNode: Element
- Optional nodeKey: any
Returns Element

getAllAppNodes

getAllAppNodes(app: AppState, selector: string): Element[]

- Defined in node_modules/preboot/src/browser/app_manager.ts:92
Get all app nodes for a given selector

Parameters
- app: AppState
- selector: string
Returns Element[]

getApp

getApp(appRoot: string): AppState

- Defined in node_modules/preboot/src/browser/app_manager.ts:46
Parameters
- appRoot: string
Returns AppState

getAppNode

getAppNode(app: AppState, selector: string): Element

- Defined in node_modules/preboot/src/browser/app_manager.ts:85
Get one app node

Parameters
- app: AppState
- selector: string
Returns Element

getClientNodes

getClientNodes(app: AppState, selector: string): Element[]

- Defined in node_modules/preboot/src/browser/app_manager.ts:99
Get all nodes under the client root

Parameters
- app: AppState
- selector: string
Returns Element[]

getDocumentNode

getDocumentNode(app: AppState): Element

- Defined in node_modules/preboot/src/browser/app_manager.ts:78
Get a node in the document

Parameters
- app: AppState
Returns Element

getNodeKey

getNodeKey(appstate: AppState, node: Element, rootNode: Element): string

- Defined in node_modules/preboot/src/browser/app_manager.ts:198
Get a unique key for a node in the DOM

Parameters
- appstate: AppState
- node: Element
- rootNode: Element
Returns string

getSelection

getSelection(node: Element): CursorSelection

- Defined in node_modules/preboot/src/browser/app_manager.ts:158
Get the caret position within a given node. Some hackery in here to make sure this works in all browsers

Parameters
- node: Element
Returns CursorSelection

initAppRoot

initAppRoot(app: AppState, options: any): any

- Defined in node_modules/preboot/src/browser/app_manager.ts:11
Parameters
- app: AppState
- options: any
Returns any

on

on(app: AppState, eventName: string, handler: Function): void

- Defined in node_modules/preboot/src/browser/app_manager.ts:71
These are global events that get passed around. Currently we use the document to do this.

Parameters
- app: AppState
- eventName: string
- handler: Function
Returns void

onLoad

onLoad(app: AppState, handler: Function): void

- Defined in node_modules/preboot/src/browser/app_manager.ts:59
Add event listener at window level

Parameters
- app: AppState
- handler: Function
Returns void

removeNode

removeNode(node: Element): void

- Defined in node_modules/preboot/src/browser/app_manager.ts:146
Remove a node since we are done with it

Parameters
- node: Element
Returns void

setSelection

setSelection(node: Element, selection: CursorSelection): void

- Defined in node_modules/preboot/src/browser/app_manager.ts:182
Set caret position in a given node

Parameters
- node: Element
- selection: CursorSelection
Returns void

updateAppRoots

updateAppRoots(app: AppState, appRoot: any, serverRoot?: any, clientRoot?: any): void

- Defined in node_modules/preboot/src/browser/app_manager.ts:21
Parameters
- app: AppState
- appRoot: any
- Optional serverRoot: any
- Optional clientRoot: any
Returns void

"node_modules/preboot/src/browser/buffer_manager"

"node_modules/preboot/src/browser/buffer_manager":

prep

prep(app: App, appstate: AppState): void

- Defined in node_modules/preboot/src/browser/buffer_manager.ts:16
Create a second div that will be the client root for an app

Parameters
- app: App
- appstate: AppState
Returns void

switchBuffer

switchBuffer(app: App, appState: AppState): void

- Defined in node_modules/preboot/src/browser/buffer_manager.ts:38
We want to simultaneously remove the server node from the DOM and display the client node

Parameters
- app: App
- appState: AppState
Returns void

state

state: object

switched

switched: boolean

"node_modules/preboot/src/browser/event_manager"

"node_modules/preboot/src/browser/event_manager":

caretPositionEvents

caretPositionEvents: Array<string>

caretPositionNodes

caretPositionNodes: Array<string>

addEventListeners

addEventListeners(app: any, appState: AppState, nodeEvents: NodeEvent[], strategy: ListenStrategy): void

- Defined in node_modules/preboot/src/browser/event_manager.ts:109
Loop through node events and add listeners

Parameters
- app: any
- appState: AppState
- nodeEvents: NodeEvent[]
- strategy: ListenStrategy
Returns void

cleanup

cleanup(app: App, appState: AppState): void

- Defined in node_modules/preboot/src/browser/event_manager.ts:164
Go through all the event listeners and clean them up by removing them from the given node (i.e. element)

Parameters
- app: App
- appState: AppState
Returns void

getEventHandler

getEventHandler(app: App, appState: AppState, strategy: ListenStrategy, node: Element, eventName: string): Function

- Defined in node_modules/preboot/src/browser/event_manager.ts:47
For a given node, add an event listener based on the given attribute. The attribute must match the Angular pattern for event handlers (i.e. either (event)='blah()' or on-event='blah'

Parameters
- app: App
- appState: AppState
- strategy: ListenStrategy
- node: Element
- eventName: string
Returns Function

replayEvents

replayEvents(app: App, appState: AppState): void

- Defined in node_modules/preboot/src/browser/event_manager.ts:148
Loop through replay strategies and call replayEvents functions. In most cases there will be only one replay strategy, but users may want to add multiple in some cases with the remaining events from one feeding into the next. Note that as with startListening() above, there are very little safety checks here in getting the replayEvents fn because those checks are in normalize.ts.

Parameters
- app: App
- appState: AppState
Returns void

startListening

startListening(app: App, appState: AppState): void

- Defined in node_modules/preboot/src/browser/event_manager.ts:131
Add event listeners based on node events found by the listen strategies. Note that the getNodeEvents fn is gathered here without many safety checks because we are doing all of those in src/server/normalize.ts.

Parameters
- app: App
- appState: AppState
Returns void

state

state: object

eventListeners

eventListeners: Array<undefined>

events

events: Array<undefined>

listening

listening: boolean

strategies

strategies: object

listen

listen: object

replay

replay: object

hydrate

hydrate: "node_modules/preboot/src/browser/replay/replay_after_hydrate"

rerender

rerender: "node_modules/preboot/src/browser/replay/replay_after_rerender"

"node_modules/preboot/src/browser/freeze/freeze_with_spinner"

"node_modules/preboot/src/browser/freeze/freeze_with_spinner":

cleanup

cleanup(app: App, appState: AppState): void

- Defined in node_modules/preboot/src/browser/freeze/freeze_with_spinner.ts:14
Clean up the freeze elements from the DOM

Parameters
- app: App
- appState: AppState
Returns void

prep

prep(app: any, appState: AppState): void

- Defined in node_modules/preboot/src/browser/freeze/freeze_with_spinner.ts:25
Prepare for freeze by adding elements to the DOM and adding an event handler

Parameters
- app: any
- appState: AppState
Returns void

state

state: object

overlay

overlay: null

spinner

spinner: null

"node_modules/preboot/src/browser/listen/listen_by_attributes"

"node_modules/preboot/src/browser/listen/listen_by_attributes":

getNodeEvents

getNodeEvents(app: App, appState: AppState, strategy: ListenStrategy): NodeEvent[]

- Defined in node_modules/preboot/src/browser/listen/listen_by_attributes.ts:9
This listen strategy will look for a specific attribute which contains all the elements that a given element is listening to. For ex.

Parameters
- app: App
- appState: AppState
- strategy: ListenStrategy
Returns NodeEvent[]

"node_modules/preboot/src/browser/listen/listen_by_event_bindings"

"node_modules/preboot/src/browser/listen/listen_by_event_bindings":

ngEventPattern

ngEventPattern: RegExp

addNodeEvents

addNodeEvents(node: any): void

- Defined in node_modules/preboot/src/browser/listen/listen_by_event_bindings.ts:34
This is function called at each node while walking DOM. Will add node event if events defined on element.

Parameters
- node: any
Returns void

getNodeEvents

getNodeEvents(app: any, appstate: AppState, strategy: ListenStrategy): NodeEvent[]

- Defined in node_modules/preboot/src/browser/listen/listen_by_event_bindings.ts:61
This listen strategy will look for a specific attribute which contains all the elements that a given element is listening to.

Parameters
- app: any
- appstate: AppState
- strategy: ListenStrategy
Returns NodeEvent[]

walkDOM

walkDOM(node: any, func: Function): void

- Defined in node_modules/preboot/src/browser/listen/listen_by_event_bindings.ts:19
This is from Crockford to walk the DOM (http: //whlp.ly/1Ii6YbR). Recursively walk DOM tree and execute input param function at each node.

Parameters
- node: any
- func: Function
Returns void

state

state: object

nodeEvents

nodeEvents: Array<undefined>

"node_modules/preboot/src/browser/listen/listen_by_selectors"

"node_modules/preboot/src/browser/listen/listen_by_selectors":

getNodeEvents

getNodeEvents(app: App, appState: AppState, strategy: ListenStrategy): NodeEvent[]

- Defined in node_modules/preboot/src/browser/listen/listen_by_selectors.ts:12
This listen strategy uses a list of selectors maped to events. For example: { 'input[type="text"],textarea': ['focusin', 'focusout'], 'button': ['click'] }

Parameters
- app: App
- appState: AppState
- strategy: ListenStrategy
Returns NodeEvent[]

"node_modules/preboot/src/browser/log"

"node_modules/preboot/src/browser/log":

log

log(...args: Array<any>): void

- Defined in node_modules/preboot/src/browser/log.ts:56
Idea here is simple. If debugging turned on and this module exists, we log various things that happen in preboot. The calling code only references a number (keys in logMap) to a handling function. By doing this, we are able to cut down on the amount of logging code in preboot when no in debug mode.

Parameters
- Rest ...args: Array<any>
Returns void

logEvents

logEvents(events: PrebootEvent[]): void

- Defined in node_modules/preboot/src/browser/log.ts:10
Parameters
- events: PrebootEvent[]
Returns void

logOptions

logOptions(opts: PrebootOptions): void

- Defined in node_modules/preboot/src/browser/log.ts:5
Parameters
- opts: PrebootOptions
Returns void

missingClientNode

missingClientNode(serverNode: Element): void

- Defined in node_modules/preboot/src/browser/log.ts:24
Parameters
- serverNode: Element
Returns void

noRefocus

noRefocus(serverNode: Element): void

- Defined in node_modules/preboot/src/browser/log.ts:36
Parameters
- serverNode: Element
Returns void

remainingEvents

remainingEvents(events: PrebootEvent[]): void

- Defined in node_modules/preboot/src/browser/log.ts:29
Parameters
- events: PrebootEvent[]
Returns void

replaySuccess

replaySuccess(serverNode: Element, clientNode: Element, event: any): void

- Defined in node_modules/preboot/src/browser/log.ts:15
Parameters
- serverNode: Element
- clientNode: Element
- event: any
Returns void

logMap

logMap: object

1

1: logOptions

2

2: logEvents

3

3: replaySuccess

4

4: missingClientNode

5

5: remainingEvents

6

6: noRefocus

"node_modules/preboot/src/browser/preboot_browser"

"node_modules/preboot/src/browser/preboot_browser":

state

state: GlobalState

complete

complete(appName: string): void

- Defined in node_modules/preboot/src/browser/preboot_browser.ts:25
Once bootstrap has completed, we replay events, switch buffer and then cleanup

Parameters
- appName: string
Returns void

completeApp

completeApp(appstate: AppState): void

- Defined in node_modules/preboot/src/browser/preboot_browser.ts:33
Parameters
- appstate: AppState
Returns void

init

init(appName: string, opts: PrebootOptions): void

- Defined in node_modules/preboot/src/browser/preboot_browser.ts:108
Initialization is really simple. Just save the options and set the window object. Most stuff happens with start() * To call multiple times like init('app1', {}), init('app2', {})

Parameters
- appName: string
- opts: PrebootOptions
Returns void

load

load(appName: string): void

- Defined in node_modules/preboot/src/browser/preboot_browser.ts:48
Get function to run once window has loaded

Parameters
- appName: string
Returns void

loadApp

loadApp(appstate: AppState): void

- Defined in node_modules/preboot/src/browser/preboot_browser.ts:56
Parameters
- appstate: AppState
Returns void

resume

resume(appName: string): void

- Defined in node_modules/preboot/src/browser/preboot_browser.ts:83
Resume the completion process; if complete already called, call it again right away

Parameters
- appName: string
Returns void

resumeApp

resumeApp(appstate: AppState): void

- Defined in node_modules/preboot/src/browser/preboot_browser.ts:93
Parameters
- appstate: AppState
Returns void

start

start(appName?: string): void

- Defined in node_modules/preboot/src/browser/preboot_browser.ts:116
Start preboot by starting to record events

Parameters
- Optional appName: string
Returns void

startApp

startApp(appstate: AppState): void

- Defined in node_modules/preboot/src/browser/preboot_browser.ts:125
Parameters
- appstate: AppState
Returns void

"node_modules/preboot/src/browser/preboot_state"

"node_modules/preboot/src/browser/preboot_state":

PrebootState

PrebootState: GlobalState

state

state: object

apps

apps: [AppState]

"node_modules/preboot/src/browser/replay/replay_after_hydrate"

"node_modules/preboot/src/browser/replay/replay_after_hydrate":

replayEvents

replayEvents(app: App, appState: AppState, strategy: ReplayStrategy, events: PrebootEvent[]): PrebootEvent[]

- Defined in node_modules/preboot/src/browser/replay/replay_after_hydrate.ts:12
this replay strategy assumes that the browser did not blow away the server generated HTML and that the elements in memory for preboot can be used to replay the events.

any events that could not be replayed for whatever reason are returned.

Parameters
- app: App
- appState: AppState
- strategy: ReplayStrategy
- events: PrebootEvent[]
Returns PrebootEvent[]

"node_modules/preboot/src/browser/replay/replay_after_rerender"

"node_modules/preboot/src/browser/replay/replay_after_rerender":

replayEvents

replayEvents(app: App, appState: AppState, strategy: ReplayStrategy, events: PrebootEvent[]): PrebootEvent[]

- Defined in node_modules/preboot/src/browser/replay/replay_after_rerender.ts:12
This replay strategy assumes that the browser completely re-rendered the page so reboot will need to find the element in the new browser rendered DOM that matches the element it has in memory.

Any events that could not be replayed for whatever reason are returned.

Parameters
- app: App
- appState: AppState
- strategy: ReplayStrategy
- events: PrebootEvent[]
Returns PrebootEvent[]

"node_modules/preboot/src/interfaces/app"

"node_modules/preboot/src/interfaces/app":

App

App:

addApp

addApp(appRoot: string, options: PrebootOptions): any

- Defined in node_modules/preboot/src/interfaces/app.ts:8
Parameters
- appRoot: string
- options: PrebootOptions
Returns any

addNodeToBody

addNodeToBody(app: AppState, type: string, className: string, styles: Object): Element

- Defined in node_modules/preboot/src/interfaces/app.ts:19
Parameters
- app: AppState
- type: string
- className: string
- styles: Object
Returns Element

appContains

appContains(app: AppState, node: Element): any

- Defined in node_modules/preboot/src/interfaces/app.ts:18
Parameters
- app: AppState
- node: Element
Returns any

dispatchGlobalEvent

dispatchGlobalEvent(app: AppState, eventName: string): any

- Defined in node_modules/preboot/src/interfaces/app.ts:16
Parameters
- app: AppState
- eventName: string
Returns any

dispatchNodeEvent

dispatchNodeEvent(app: AppState, node: Element, eventName: string): any

- Defined in node_modules/preboot/src/interfaces/app.ts:17
Parameters
- app: AppState
- node: Element
- eventName: string
Returns any

findClientNode

findClientNode(app: AppState, serverNode: Element, nodeKey?: any): Element

- Defined in node_modules/preboot/src/interfaces/app.ts:24
Parameters
- app: AppState
- serverNode: Element
- Optional nodeKey: any
Returns Element

getAllAppNodes

getAllAppNodes(app: AppState, selector: string): Element[]

- Defined in node_modules/preboot/src/interfaces/app.ts:14
Parameters
- app: AppState
- selector: string
Returns Element[]

getApp

getApp(appRoot: string): any

- Defined in node_modules/preboot/src/interfaces/app.ts:9
Parameters
- appRoot: string
Returns any

getAppNode

getAppNode(app: AppState, selector: string): Element

- Defined in node_modules/preboot/src/interfaces/app.ts:13
Parameters
- app: AppState
- selector: string
Returns Element

getClientNodes

getClientNodes(app: AppState, selector: string): Element[]

- Defined in node_modules/preboot/src/interfaces/app.ts:15
Parameters
- app: AppState
- selector: string
Returns Element[]

getDocumentNode

getDocumentNode(app: AppState): Element

- Defined in node_modules/preboot/src/interfaces/app.ts:12
Parameters
- app: AppState
Returns Element

getNodeKey

getNodeKey(appstate: AppState, node: Element, rootNode: Element): string

- Defined in node_modules/preboot/src/interfaces/app.ts:23
Parameters
- appstate: AppState
- node: Element
- rootNode: Element
Returns string

getSelection

getSelection(node: Element): CursorSelection

- Defined in node_modules/preboot/src/interfaces/app.ts:21
Parameters
- node: Element
Returns CursorSelection

initAppRoot

initAppRoot(app: AppState, options: any): any

- Defined in node_modules/preboot/src/interfaces/app.ts:6
Parameters
- app: AppState
- options: any
Returns any

on

on(app: AppState, eventName: string, handler: Function): any

- Defined in node_modules/preboot/src/interfaces/app.ts:11
Parameters
- app: AppState
- eventName: string
- handler: Function
Returns any

onLoad

onLoad(app: AppState, handler: Function): any

- Defined in node_modules/preboot/src/interfaces/app.ts:10
Parameters
- app: AppState
- handler: Function
Returns any

removeNode

removeNode(node: Element): any

- Defined in node_modules/preboot/src/interfaces/app.ts:20
Parameters
- node: Element
Returns any

setSelection

setSelection(node: Element, selection: CursorSelection): any

- Defined in node_modules/preboot/src/interfaces/app.ts:22
Parameters
- node: Element
- selection: CursorSelection
Returns any

updateAppRoots

updateAppRoots(app: AppState, appRoot: any, serverRoot?: any, clientRoot?: any): any

- Defined in node_modules/preboot/src/interfaces/app.ts:7
Parameters
- app: AppState
- appRoot: any
- Optional serverRoot: any
- Optional clientRoot: any
Returns any

AppState

AppState:

activeNode

activeNode: any

appRoot

appRoot: any

appRootName

appRootName: string

body

body: any

canComplete

canComplete: boolean

clientRoot

clientRoot: any

completeCalled

completeCalled: boolean

document

document: any

freeze

freeze: any

opts

opts: PrebootOptions

selection

selection: CursorSelection

serverRoot

serverRoot: any

started

started: boolean

switched

switched: boolean

window

window: any

GlobalState

GlobalState:

apps

apps: [AppState]

"node_modules/preboot/src/interfaces/element"

"node_modules/preboot/src/interfaces/element":

Element

Element:

attributes

attributes: string[]

checked

checked: boolean

childNodes

childNodes: Element[]

className

className: string

id

id: string

nodeName

nodeName: string

parentNode

parentNode: Element

selected

selected: boolean

selection

selection: any

selectionDirection

selectionDirection: string

selectionEnd

selectionEnd: number

selectionStart

selectionStart: number

style

style: Style

tagName

tagName: string

value

value: string

cloneNode

cloneNode(deep: boolean): Element

- Defined in node_modules/preboot/src/interfaces/element.ts:29
Parameters
- deep: boolean
Returns Element

createTextRange

createTextRange(): any

- Defined in node_modules/preboot/src/interfaces/element.ts:19
Returns any

dispatchEvent

dispatchEvent(event: DomEvent): any

- Defined in node_modules/preboot/src/interfaces/element.ts:27
Parameters
- event: DomEvent
Returns any

focus

focus(): any

- Defined in node_modules/preboot/src/interfaces/element.ts:26
Returns any

getAttribute

getAttribute(name: string): string

- Defined in node_modules/preboot/src/interfaces/element.ts:28
Parameters
- name: string
Returns string

insertBefore

insertBefore(nodeToInsert: Element, beforeNode: Element): any

- Defined in node_modules/preboot/src/interfaces/element.ts:30
Parameters
- nodeToInsert: Element
- beforeNode: Element
Returns any

remove

remove(): any

- Defined in node_modules/preboot/src/interfaces/element.ts:25
Returns any

setSelectionRange

setSelectionRange(fromPos: number, toPos: number, direction: string): any

- Defined in node_modules/preboot/src/interfaces/element.ts:20
Parameters
- fromPos: number
- toPos: number
- direction: string
Returns any

Style

Style:

display

display: string

"node_modules/preboot/src/interfaces/event"

"node_modules/preboot/src/interfaces/event":

DomEvent

DomEvent:

target

target: any

type

type: string

which

which: number

preventDefault

preventDefault(): any

- Defined in node_modules/preboot/src/interfaces/event.ts:22
Returns any

NodeEvent

NodeEvent:

eventName

eventName: string

node

node: any

PrebootEvent

PrebootEvent:

appName

appName: string

event

event: any

name

node

node: any

nodeKey

nodeKey: any

time

time: number

"node_modules/preboot/src/interfaces/preboot_options"

"node_modules/preboot/src/interfaces/preboot_options":

FreezeStyles

FreezeStyles:

overlay

overlay: Styles

spinner

spinner: Styles

PrebootOptions

PrebootOptions:

appRoot

appRoot: [string]

buffer

buffer: boolean

completeEvent

completeEvent: string

debug

debug: boolean

disableCodeCache

disableCodeCache: boolean

freeze

freeze: any

listen

listen: any

pauseEvent

pauseEvent: string

presets

presets: any

replay

replay: any

resumeEvent

resumeEvent: string

uglify

uglify: boolean

Styles

Styles:

className

className: string

style

style: Object

"node_modules/preboot/src/interfaces/preboot_ref"

"node_modules/preboot/src/interfaces/preboot_ref":

CursorSelection

CursorSelection:

direction

direction: string

end

end: number

start

start: number

Dom

Dom:

addNodeToBody

addNodeToBody(app: AppState, type: string, className: string, styles: Object): Element

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:23
Parameters
- app: AppState
- type: string
- className: string
- styles: Object
Returns Element

appContains

appContains(app: AppState, node: Element): Boolean

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:22
Parameters
- app: AppState
- node: Element
Returns Boolean

dispatchGlobalEvent

dispatchGlobalEvent(app: AppState, eventName: string): any

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:20
Parameters
- app: AppState
- eventName: string
Returns any

dispatchNodeEvent

dispatchNodeEvent(app: AppState, node: Element, eventName: string): any

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:21
Parameters
- app: AppState
- node: Element
- eventName: string
Returns any

findClientNode

findClientNode(app: AppState, serverNode: Element, nodeKey?: any): Element

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:25
Parameters
- app: AppState
- serverNode: Element
- Optional nodeKey: any
Returns Element

getAllAppNodes

getAllAppNodes(app: AppState, selector: string): Element[]

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:16
Parameters
- app: AppState
- selector: string
Returns Element[]

getAppNode

getAppNode(app: AppState, selector: string): Element

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:14
Parameters
- app: AppState
- selector: string
Returns Element

getClientNodes

getClientNodes(app: AppState, selector: string): Element[]

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:17
Parameters
- app: AppState
- selector: string
Returns Element[]

getDocumentNode

getDocumentNode(app: AppState): Element

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:13
Parameters
- app: AppState
Returns Element

getNodeKey

getNodeKey(node: Element, rootNode: Element): string

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:15
Parameters
- node: Element
- rootNode: Element
Returns string

getSelection

getSelection(node: Element): CursorSelection

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:26
Parameters
- node: Element
Returns CursorSelection

on

on(eventName: string, handler: Function): any

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:19
Parameters
- eventName: string
- handler: Function
Returns any

onLoad

onLoad(handler: Function): any

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:18
Parameters
- handler: Function
Returns any

removeNode

removeNode(node: Element): any

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:24
Parameters
- node: Element
Returns any

setSelection

setSelection(node: Element, selection: CursorSelection): any

- Defined in node_modules/preboot/src/interfaces/preboot_ref.ts:27
Parameters
- node: Element
- selection: CursorSelection
Returns any

"node_modules/preboot/src/interfaces/strategy"

"node_modules/preboot/src/interfaces/strategy":

ListenStrategy

ListenStrategy:

attributeName

attributeName: string

dispatchEvent

dispatchEvent: string

doNotReplay

doNotReplay: boolean

eventsBySelector

eventsBySelector: Object

name

preventDefault

preventDefault: boolean

trackFocus

trackFocus: boolean

action

action(appstate: AppState, node: Element, event: DomEvent): any

- Defined in node_modules/preboot/src/interfaces/strategy.ts:13
Parameters
- appstate: AppState
- node: Element
- event: DomEvent
Returns any

ReplayStrategy

ReplayStrategy:

checkIfExists

checkIfExists: boolean

name

"node_modules/preboot/src/node/browser_code_generator"

"node_modules/preboot/src/node/browser_code_generator":

browserCodeCache

browserCodeCache: object

Type declaration

getClientCode

getClientCode: getBrowserCode

getClientCodeStream

getClientCodeStream: getBrowserCodeStream

getBrowserCode

getBrowserCode(appName: string, opts?: PrebootOptions, done?: Function): any

- Defined in node_modules/preboot/src/node/browser_code_generator.ts:83
Generate browser code as a string for preboot based on the input options

Parameters
- appName: string
- Optional opts: PrebootOptions
- Optional done: Function
Returns any

getBrowserCodeStream

getBrowserCodeStream(appName: string, opts?: PrebootOptions): any

- Defined in node_modules/preboot/src/node/browser_code_generator.ts:41
Generate browser code as a readable stream for preboot based on the input options

Parameters
- appName: string
- Optional opts: PrebootOptions
Returns any

ignoreUnusedStrategies

ignoreUnusedStrategies(b: any, bOpts: Object, strategyOpts: any[], allStrategies: Object, pathPrefix: string): void

- Defined in node_modules/preboot/src/node/browser_code_generator.ts:22
We want to use the browserify ignore functionality so that any code modules that are not being used are stubbed out. So, for example, if in the preboot options the only listen strategy is selectors, then the event_bindings and attributes strategies will be stubbed out (meaing the refs will be {})

Parameters
- b: any
- bOpts: Object
- strategyOpts: any[]
- allStrategies: Object
- pathPrefix: string
Returns void

"node_modules/preboot/src/node/normalize"

"node_modules/preboot/src/node/normalize":

normalize

normalize(opts: PrebootOptions): PrebootOptions

- Defined in node_modules/preboot/src/node/normalize.ts:194
Normalize options so user can enter shorthand and it is expanded as appropriate for the browser code

Parameters
- opts: PrebootOptions
Returns PrebootOptions

defaultFreezeStyles

defaultFreezeStyles: object

overlay

overlay: object

className

className: string

style

style: object

display

display: string

height

height: string

left

left: string

position

position: string

top

top: string

width

width: string

zIndex

zIndex: string

spinner

spinner: object

className

className: string

style

style: object

display

display: string

position

position: string

zIndex

zIndex: string

freezeStrategies

freezeStrategies: object

spinner

spinner: boolean

listenStrategies

listenStrategies: object

attributes

attributes: boolean

event_bindings

event_bindings: boolean

selectors

selectors: boolean

normalizers

normalizers: object

completeEvent

completeEvent(opts: PrebootOptions): void

- Defined in node_modules/preboot/src/node/normalize.ts:57
Parameters
- opts: PrebootOptions
Returns void

freeze

freeze(opts: PrebootOptions): void

- Defined in node_modules/preboot/src/node/normalize.ts:131
Make sure freeze options are array of FreezeStrategy objects. We have a set of base styles that are used for freeze (i.e. for overaly and spinner), but these can be overriden

Parameters
- opts: PrebootOptions
Returns void

listen

listen(opts: PrebootOptions): void

- Defined in node_modules/preboot/src/node/normalize.ts:65
Make sure that the listen option is an array of ListenStrategy objects so client side doesn't need to worry about conversions

Parameters
- opts: PrebootOptions
Returns void

pauseEvent

pauseEvent(opts: PrebootOptions): void

- Defined in node_modules/preboot/src/node/normalize.ts:46
Just set default pauseEvent if doesn't exist

Parameters
- opts: PrebootOptions
Returns void

presets

presets(opts: PrebootOptions): void

- Defined in node_modules/preboot/src/node/normalize.ts:163
Presets are modifications to options. In the future, we may be simple presets like 'angular' which add all the listeners and replay.

Parameters
- opts: PrebootOptions
Returns void

replay

replay(opts: PrebootOptions): void

- Defined in node_modules/preboot/src/node/normalize.ts:98
Make sure replay options are array of ReplayStrategy objects. So, callers can just pass in simple string, but converted to an array before passed into client side preboot.

Parameters
- opts: PrebootOptions
Returns void

resumeEvent

resumeEvent(opts: PrebootOptions): void

- Defined in node_modules/preboot/src/node/normalize.ts:53
Set default resumeEvent if doesn't exist

Parameters
- opts: PrebootOptions
Returns void

replayStrategies

replayStrategies: object

hydrate

hydrate: boolean

rerender

rerender: boolean

"node_modules/preboot/src/node/preboot_node"

"node_modules/preboot/src/node/preboot_node":

"node_modules/preboot/src/node/presets"

"node_modules/preboot/src/node/presets":

"node_modules/preboot/src/node/utils"

"node_modules/preboot/src/node/utils":

FUNC_START

FUNC_START: string

FUNC_STOP

FUNC_STOP: string

stringifyWithFunctions

stringifyWithFunctions(obj: Object): String

- Defined in node_modules/preboot/src/node/utils.ts:7
Stringify an object and include functions

Parameters
- obj: Object
Returns String

"node_modules/reflect-metadata/Reflect"

"node_modules/reflect-metadata/Reflect":

Reflect

Reflect:

BufferLike

BufferLike:

length

length: number

WorkerGlobalScope

WorkerGlobalScope: any

_Map

_Map: MapConstructor

_Set

_Set: SetConstructor

_WeakMap

_WeakMap: WeakMapConstructor

_Metadata

___Metadata__: WeakMap<Object, Map<string | symbol, Map<any, any>>>

crypto

crypto: Crypto

functionPrototype

functionPrototype: any

global

global: any

module

module: any

require

require: Function

CreateMapPolyfill

CreateMapPolyfill(): any

- Defined in node_modules/reflect-metadata/Reflect.ts:1241
Returns any

CreateSetPolyfill

CreateSetPolyfill(): any

- Defined in node_modules/reflect-metadata/Reflect.ts:1316
Returns any

CreateWeakMapPolyfill

CreateWeakMapPolyfill(): any

- Defined in node_modules/reflect-metadata/Reflect.ts:1346
Returns any

DecorateConstructor

DecorateConstructor(decorators: ClassDecorator[], target: Function): Function

- Defined in node_modules/reflect-metadata/Reflect.ts:1004
Parameters
- decorators: ClassDecorator[]
- target: Function
Returns Function

DecoratePropertyWithDescriptor

DecoratePropertyWithDescriptor(decorators: MethodDecorator[], target: Object, propertyKey: string | symbol, descriptor: PropertyDescriptor): PropertyDescriptor

- Defined in node_modules/reflect-metadata/Reflect.ts:1018
Parameters
- decorators: MethodDecorator[]
- target: Object
- propertyKey: string | symbol
- descriptor: PropertyDescriptor
Returns PropertyDescriptor

DecoratePropertyWithoutDescriptor

DecoratePropertyWithoutDescriptor(decorators: PropertyDecorator[], target: Object, propertyKey: string | symbol): void

- Defined in node_modules/reflect-metadata/Reflect.ts:1032
Parameters
- decorators: PropertyDecorator[]
- target: Object
- propertyKey: string | symbol
Returns void

GetOrCreateMetadataMap

GetOrCreateMetadataMap(target: Object, targetKey: string | symbol, create: boolean): Map<any, any>

- Defined in node_modules/reflect-metadata/Reflect.ts:1040
Parameters
- target: Object
- targetKey: string | symbol
- create: boolean
Returns Map<any, any>

GetPrototypeOf

GetPrototypeOf(O: any): Object

- Defined in node_modules/reflect-metadata/Reflect.ts:1200
Parameters
- O: any
Returns Object

IsArray

IsArray(x: any): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:1173
Parameters
- x: any
Returns boolean

IsConstructor

IsConstructor(x: any): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:1183
Parameters
- x: any
Returns boolean

IsObject

IsObject(x: any): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:1178
Parameters
- x: any
Returns boolean

IsSymbol

IsSymbol(x: any): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:1188
Parameters
- x: any
Returns boolean

IsUndefined

IsUndefined(x: any): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:1168
Parameters
- x: any
Returns boolean

OrdinaryDefineOwnMetadata

OrdinaryDefineOwnMetadata(MetadataKey: any, MetadataValue: any, O: Object, P: string | symbol): void

- Defined in node_modules/reflect-metadata/Reflect.ts:1113
Parameters
- MetadataKey: any
- MetadataValue: any
- O: Object
- P: string | symbol
Returns void

OrdinaryGetMetadata

OrdinaryGetMetadata(MetadataKey: any, O: Object, P: string | symbol): any

- Defined in node_modules/reflect-metadata/Reflect.ts:1088
Parameters
- MetadataKey: any
- O: Object
- P: string | symbol
Returns any

OrdinaryGetOwnMetadata

OrdinaryGetOwnMetadata(MetadataKey: any, O: Object, P: string | symbol): any

- Defined in node_modules/reflect-metadata/Reflect.ts:1103
Parameters
- MetadataKey: any
- O: Object
- P: string | symbol
Returns any

OrdinaryHasMetadata

OrdinaryHasMetadata(MetadataKey: any, O: Object, P: string | symbol): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:1063
Parameters
- MetadataKey: any
- O: Object
- P: string | symbol
Returns boolean

OrdinaryHasOwnMetadata

OrdinaryHasOwnMetadata(MetadataKey: any, O: Object, P: string | symbol): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:1078
Parameters
- MetadataKey: any
- O: Object
- P: string | symbol
Returns boolean

OrdinaryMetadataKeys

OrdinaryMetadataKeys(O: Object, P: string | symbol): any[]

- Defined in node_modules/reflect-metadata/Reflect.ts:1119
Parameters
- O: Object
- P: string | symbol
Returns any[]

OrdinaryOwnMetadataKeys

OrdinaryOwnMetadataKeys(target: Object, targetKey: string | symbol): any[]

- Defined in node_modules/reflect-metadata/Reflect.ts:1157
Parameters
- target: Object
- targetKey: string | symbol
Returns any[]

ToPropertyKey

ToPropertyKey(value: any): string | symbol

- Defined in node_modules/reflect-metadata/Reflect.ts:1193
Parameters
- value: any
Returns string | symbol

decorate

decorate(decorators: ClassDecorator[], target: Function): Function
decorate(decorators: function | function, target: Object, targetKey: string | symbol, descriptor?: PropertyDescriptor): PropertyDescriptor

- Defined in node_modules/reflect-metadata/Reflect.ts:47
Applies a set of decorators to a target object.
remarks

Decorators are applied in reverse order of their positions in the array.

example
```
class C { }

// constructor
C = Reflect.decorate(decoratorsArray, C);
```
Parameters
- decorators: ClassDecorator[]
  
  An array of decorators.
- target: Function
  
  The target object.
Returns Function

The result of applying the provided decorators.

Applies a set of decorators to a property of a target object.

remarks

Decorators are applied in reverse order.

example

class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod() { }
    method() { }
}

// property (on constructor)
Reflect.decorate(decoratorsArray, C, "staticProperty");

// property (on prototype)
Reflect.decorate(decoratorsArray, C.prototype, "property");

// method (on constructor)
Object.defineProperty(C, "staticMethod",
    Reflect.decorate(decoratorsArray, C, "staticMethod",
        Object.getOwnPropertyDescriptor(C, "staticMethod")));

// method (on prototype)
Object.defineProperty(C.prototype, "method",
    Reflect.decorate(decoratorsArray, C.prototype, "method",
        Object.getOwnPropertyDescriptor(C.prototype, "method")));

Parameters

decorators: function | function

An array of decorators.
target: Object

The target object.
targetKey: string | symbol

(Optional) The property key to decorate.
Optional descriptor: PropertyDescriptor

A property descriptor

Returns PropertyDescriptor

defineMetadata

defineMetadata(metadataKey: any, metadataValue: any, target: Object): void
defineMetadata(metadataKey: any, metadataValue: any, target: Object, targetKey: string | symbol): void

- Defined in node_modules/reflect-metadata/Reflect.ts:249
Define a unique metadata entry on the target.
example
```
class C {
}

// constructor
Reflect.defineMetadata("custom:annotation", options, C);

// decorator factory as metadata-producing annotation.
function MyAnnotation(options): ClassDecorator {
    return target => Reflect.defineMetadata("custom:annotation", options, target);
}
```
Parameters
- metadataKey: any
  
  A key used to store and retrieve metadata.
- metadataValue: any
  
  A value that contains attached metadata.
- target: Object
  
  The target object on which to define metadata.
Returns void

Define a unique metadata entry on the target.

example

class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
Reflect.defineMetadata("custom:annotation", Number, C, "staticProperty");

// property (on prototype)
Reflect.defineMetadata("custom:annotation", Number, C.prototype, "property");

// method (on constructor)
Reflect.defineMetadata("custom:annotation", Number, C, "staticMethod");

// method (on prototype)
Reflect.defineMetadata("custom:annotation", Number, C.prototype, "method");

// decorator factory as metadata-producing annotation.
function MyAnnotation(options): PropertyDecorator {
    return (target, key) => Reflect.defineMetadata("custom:annotation", options, target, key);
}

Parameters

metadataKey: any

A key used to store and retrieve metadata.
metadataValue: any

A value that contains attached metadata.
target: Object

The target object on which to define metadata.
targetKey: string | symbol

(Optional) The property key for the target.

Returns void

deleteMetadata

deleteMetadata(metadataKey: any, target: Object): boolean
deleteMetadata(metadataKey: any, target: Object, targetKey: string | symbol): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:904
Deletes the metadata entry from the target object with the provided key.
example
```
class C {
}

// constructor
result = Reflect.deleteMetadata("custom:annotation", C);
```
Parameters
- metadataKey: any
  
  A key used to store and retrieve metadata.
- target: Object
  
  The target object on which the metadata is defined.
Returns boolean

true if the metadata entry was found and deleted; otherwise, false.

Deletes the metadata entry from the target object with the provided key.

example

class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.deleteMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.deleteMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.deleteMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.deleteMetadata("custom:annotation", C.prototype, "method");

Parameters

metadataKey: any

A key used to store and retrieve metadata.
target: Object

The target object on which the metadata is defined.
targetKey: string | symbol

(Optional) The property key for the target.

Returns boolean

true if the metadata entry was found and deleted; otherwise, false.

getMetadata

getMetadata(metadataKey: any, target: Object): any
getMetadata(metadataKey: any, target: Object, targetKey: string | symbol): any

- Defined in node_modules/reflect-metadata/Reflect.ts:538
Gets the metadata value for the provided metadata key on the target object or its prototype chain.
example
```
class C {
}

// constructor
result = Reflect.getMetadata("custom:annotation", C);
```
Parameters
- metadataKey: any
  
  A key used to store and retrieve metadata.
- target: Object
  
  The target object on which the metadata is defined.
Returns any

The metadata value for the metadata key if found; otherwise, undefined.

Gets the metadata value for the provided metadata key on the target object or its prototype chain.

example

class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.getMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.getMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.getMetadata("custom:annotation", C.prototype, "method");

Parameters

metadataKey: any

A key used to store and retrieve metadata.
target: Object

The target object on which the metadata is defined.
targetKey: string | symbol

(Optional) The property key for the target.

Returns any

The metadata value for the metadata key if found; otherwise, undefined.

getMetadataKeys

getMetadataKeys(target: Object): any[]
getMetadataKeys(target: Object, targetKey: string | symbol): any[]

- Defined in node_modules/reflect-metadata/Reflect.ts:723
Gets the metadata keys defined on the target object or its prototype chain.
example
```
class C {
}

// constructor
result = Reflect.getMetadataKeys(C);
```
Parameters
- target: Object
  
  The target object on which the metadata is defined.
Returns any[]

An array of unique metadata keys.

Gets the metadata keys defined on the target object or its prototype chain.

example

class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getMetadataKeys(C, "staticProperty");

// property (on prototype)
result = Reflect.getMetadataKeys(C.prototype, "property");

// method (on constructor)
result = Reflect.getMetadataKeys(C, "staticMethod");

// method (on prototype)
result = Reflect.getMetadataKeys(C.prototype, "method");

Parameters

target: Object

The target object on which the metadata is defined.
targetKey: string | symbol

(Optional) The property key for the target.

Returns any[]

An array of unique metadata keys.

getOwnMetadata

getOwnMetadata(metadataKey: any, target: Object): any
getOwnMetadata(metadataKey: any, target: Object, targetKey: string | symbol): any

- Defined in node_modules/reflect-metadata/Reflect.ts:631
Gets the metadata value for the provided metadata key on the target object.
example
```
class C {
}

// constructor
result = Reflect.getOwnMetadata("custom:annotation", C);
```
Parameters
- metadataKey: any
  
  A key used to store and retrieve metadata.
- target: Object
  
  The target object on which the metadata is defined.
Returns any

The metadata value for the metadata key if found; otherwise, undefined.

Gets the metadata value for the provided metadata key on the target object.

example

class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getOwnMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.getOwnMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.getOwnMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.getOwnMetadata("custom:annotation", C.prototype, "method");

Parameters

metadataKey: any

A key used to store and retrieve metadata.
target: Object

The target object on which the metadata is defined.
targetKey: string | symbol

(Optional) The property key for the target.

Returns any

The metadata value for the metadata key if found; otherwise, undefined.

getOwnMetadataKeys

getOwnMetadataKeys(target: Object): any[]
getOwnMetadataKeys(target: Object, targetKey: string | symbol): any[]

- Defined in node_modules/reflect-metadata/Reflect.ts:813
Gets the unique metadata keys defined on the target object.
example
```
class C {
}

// constructor
result = Reflect.getOwnMetadataKeys(C);
```
Parameters
- target: Object
  
  The target object on which the metadata is defined.
Returns any[]

An array of unique metadata keys.

Gets the unique metadata keys defined on the target object.

example

class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.getOwnMetadataKeys(C, "staticProperty");

// property (on prototype)
result = Reflect.getOwnMetadataKeys(C.prototype, "property");

// method (on constructor)
result = Reflect.getOwnMetadataKeys(C, "staticMethod");

// method (on prototype)
result = Reflect.getOwnMetadataKeys(C.prototype, "method");

Parameters

target: Object

The target object on which the metadata is defined.
targetKey: string | symbol

(Optional) The property key for the target.

Returns any[]

An array of unique metadata keys.

hasMetadata

hasMetadata(metadataKey: any, target: Object): boolean
hasMetadata(metadataKey: any, target: Object, targetKey: string | symbol): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:352
Gets a value indicating whether the target object or its prototype chain has the provided metadata key defined.
example
```
class C {
}

// constructor
result = Reflect.hasMetadata("custom:annotation", C);
```
Parameters
- metadataKey: any
  
  A key used to store and retrieve metadata.
- target: Object
  
  The target object on which the metadata is defined.
Returns boolean

true if the metadata key was defined on the target object or its prototype chain; otherwise, false.

Gets a value indicating whether the target object or its prototype chain has the provided metadata key defined.

example

class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.hasMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.hasMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.hasMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.hasMetadata("custom:annotation", C.prototype, "method");

Parameters

metadataKey: any

A key used to store and retrieve metadata.
target: Object

The target object on which the metadata is defined.
targetKey: string | symbol

(Optional) The property key for the target.

Returns boolean

true if the metadata key was defined on the target object or its prototype chain; otherwise, false.

hasOwnMetadata

hasOwnMetadata(metadataKey: any, target: Object): boolean
hasOwnMetadata(metadataKey: any, target: Object, targetKey: string | symbol): boolean

- Defined in node_modules/reflect-metadata/Reflect.ts:445
Gets a value indicating whether the target object has the provided metadata key defined.
example
```
class C {
}

// constructor
result = Reflect.hasOwnMetadata("custom:annotation", C);
```
Parameters
- metadataKey: any
  
  A key used to store and retrieve metadata.
- target: Object
  
  The target object on which the metadata is defined.
Returns boolean

true if the metadata key was defined on the target object; otherwise, false.

Gets a value indicating whether the target object has the provided metadata key defined.

example

class C {
    // property declarations are not part of ES6, though they are valid in TypeScript:
    // static staticProperty;
    // property;

    static staticMethod(p) { }
    method(p) { }
}

// property (on constructor)
result = Reflect.hasOwnMetadata("custom:annotation", C, "staticProperty");

// property (on prototype)
result = Reflect.hasOwnMetadata("custom:annotation", C.prototype, "property");

// method (on constructor)
result = Reflect.hasOwnMetadata("custom:annotation", C, "staticMethod");

// method (on prototype)
result = Reflect.hasOwnMetadata("custom:annotation", C.prototype, "method");

Parameters

metadataKey: any

A key used to store and retrieve metadata.
target: Object

The target object on which the metadata is defined.
targetKey: string | symbol

(Optional) The property key for the target.

Returns boolean

true if the metadata key was defined on the target object; otherwise, false.

metadata

metadata(metadataKey: any, metadataValue: any): decorator

A default metadata decorator factory that can be used on a class, class member, or parameter.

remarks

If metadataKey is already defined for the target and target key, the metadataValue for that key will be overwritten.

example

// constructor
@Reflect.metadata(key, value)
class C {
}

// property (on constructor, TypeScript only)
class C {
    @Reflect.metadata(key, value)
    static staticProperty;
}

// property (on prototype, TypeScript only)
class C {
    @Reflect.metadata(key, value)
    property;
}

// method (on constructor)
class C {
    @Reflect.metadata(key, value)
    static staticMethod() { }
}

// method (on prototype)
class C {
    @Reflect.metadata(key, value)
    method() { }
}

Parameters

metadataKey: any

The key for the metadata entry.
metadataValue: any

The value for the metadata entry.

Returns decorator

A decorator function.

"node_modules/reflect-metadata/test/harness"

"node_modules/reflect-metadata/test/harness":

TestResults

TestResults:

failed

failed: [string, any]

passed

passed: string[]

printResults

printResults(results: TestResults): void

- Defined in node_modules/reflect-metadata/test/harness.ts:23
Parameters
- results: TestResults
Returns void

runTests

runTests(fixture: any): TestResults

- Defined in node_modules/reflect-metadata/test/harness.ts:6
Parameters
- fixture: any
Returns TestResults

"node_modules/reflect-metadata/test/reflect/reflect-decorate"

"node_modules/reflect-metadata/test/reflect/reflect-decorate":

ReflectDecorateExecutesDecoratorsInReverseOrderForFunctionOverload

ReflectDecorateExecutesDecoratorsInReverseOrderForFunctionOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:45
Returns void

ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyDescriptorOverload

ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyDescriptorOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:68
Returns void

ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyOverload

ReflectDecorateExecutesDecoratorsInReverseOrderForPropertyOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:56
Returns void

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForFunctionOverload

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForFunctionOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:6
Returns void

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyDescriptorOverload

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyDescriptorOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:30
Returns void

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyOverload

ReflectDecorateThrowsIfDecoratorsArgumentNotArrayForPropertyOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:17
Returns void

ReflectDecorateThrowsIfTargetArgumentNotFunctionForFunctionOverload

ReflectDecorateThrowsIfTargetArgumentNotFunctionForFunctionOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:11
Returns void

ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyDescriptorOverload

ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyDescriptorOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:37
Returns void

ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyOverload

ReflectDecorateThrowsIfTargetArgumentNotObjectForPropertyOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:23
Returns void

ReflectDecoratorCorrectDescriptorInPipelineForPropertyDescriptorOverload

ReflectDecoratorCorrectDescriptorInPipelineForPropertyDescriptorOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:194
Returns void

ReflectDecoratorCorrectNameInPipelineForPropertyDescriptorOverload

ReflectDecoratorCorrectNameInPipelineForPropertyDescriptorOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:178
Returns void

ReflectDecoratorCorrectNameInPipelineForPropertyOverload

ReflectDecoratorCorrectNameInPipelineForPropertyOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:149
Returns void

ReflectDecoratorCorrectTargetInPipelineForFunctionOverload

ReflectDecoratorCorrectTargetInPipelineForFunctionOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:121
Returns void

ReflectDecoratorCorrectTargetInPipelineForPropertyDescriptorOverload

ReflectDecoratorCorrectTargetInPipelineForPropertyDescriptorOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:162
Returns void

ReflectDecoratorCorrectTargetInPipelineForPropertyOverload

ReflectDecoratorCorrectTargetInPipelineForPropertyOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:136
Returns void

ReflectDecoratorPipelineForFunctionOverload

ReflectDecoratorPipelineForFunctionOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:81
Returns void

ReflectDecoratorPipelineForPropertyDescriptorOverload

ReflectDecoratorPipelineForPropertyDescriptorOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:107
Returns void

ReflectDecoratorPipelineForPropertyOverload

ReflectDecoratorPipelineForPropertyOverload(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-decorate.ts:94
Returns void

"node_modules/reflect-metadata/test/reflect/reflect-definemetadata"

"node_modules/reflect-metadata/test/reflect/reflect-definemetadata":

ReflectDefineMetadataInvalidTarget

ReflectDefineMetadataInvalidTarget(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-definemetadata.ts:7
Returns void

ReflectDefineMetadataValidTargetWithTargetKey

ReflectDefineMetadataValidTargetWithTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-definemetadata.ts:15
Returns void

ReflectDefineMetadataValidTargetWithoutTargetKey

ReflectDefineMetadataValidTargetWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-definemetadata.ts:11
Returns void

"node_modules/reflect-metadata/test/reflect/reflect-deletemetadata"

"node_modules/reflect-metadata/test/reflect/reflect-deletemetadata":

ReflectDeleteMetadataInvalidTarget

ReflectDeleteMetadataInvalidTarget(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-deletemetadata.ts:7
Returns void

ReflectDeleteMetadataWhenDefinedOnPrototypeWithoutTargetKey

ReflectDeleteMetadataWhenDefinedOnPrototypeWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-deletemetadata.ts:24
Returns void

ReflectDeleteMetadataWhenDefinedWithoutTargetKey

ReflectDeleteMetadataWhenDefinedWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-deletemetadata.ts:17
Returns void

ReflectDeleteMetadataWhenNotDefinedWithoutTargetKey

ReflectDeleteMetadataWhenNotDefinedWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-deletemetadata.ts:11
Returns void

ReflectHasOwnMetadataAfterDeleteMetadata

ReflectHasOwnMetadataAfterDeleteMetadata(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-deletemetadata.ts:32
Returns void

"node_modules/reflect-metadata/test/reflect/reflect-getmetadata"

"node_modules/reflect-metadata/test/reflect/reflect-getmetadata":

ReflectGetMetadataInvalidTarget

ReflectGetMetadataInvalidTarget(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadata.ts:7
Returns void

ReflectGetMetadataWithTargetKeyWhenDefined

ReflectGetMetadataWithTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadata.ts:38
Returns void

ReflectGetMetadataWithTargetKeyWhenDefinedOnPrototype

ReflectGetMetadataWithTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadata.ts:45
Returns void

ReflectGetMetadataWithTargetKeyWhenNotDefined

ReflectGetMetadataWithTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadata.ts:32
Returns void

ReflectGetMetadataWithoutTargetKeyWhenDefined

ReflectGetMetadataWithoutTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadata.ts:17
Returns void

ReflectGetMetadataWithoutTargetKeyWhenDefinedOnPrototype

ReflectGetMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadata.ts:24
Returns void

ReflectGetMetadataWithoutTargetKeyWhenNotDefined

ReflectGetMetadataWithoutTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadata.ts:11
Returns void

"node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys"

"node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys":

ReflectGetMetadataKeysInvalidTarget

ReflectGetMetadataKeysInvalidTarget(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:7
Returns void

ReflectGetMetadataKeysOrderAfterRedefineWithTargetKey

ReflectGetMetadataKeysOrderAfterRedefineWithTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:81
Returns void

ReflectGetMetadataKeysOrderAfterRedefineWithoutTargetKey

ReflectGetMetadataKeysOrderAfterRedefineWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:41
Returns void

ReflectGetMetadataKeysOrderWithTargetKeyWhenDefinedOnPrototype

ReflectGetMetadataKeysOrderWithTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:90
Returns void

ReflectGetMetadataKeysOrderWithoutTargetKey

ReflectGetMetadataKeysOrderWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:33
Returns void

ReflectGetMetadataKeysOrderWithoutTargetKeyWhenDefinedOnPrototype

ReflectGetMetadataKeysOrderWithoutTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:50
Returns void

ReflectGetMetadataKeysWithTargetKeyWhenDefined

ReflectGetMetadataKeysWithTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:66
Returns void

ReflectGetMetadataKeysWithTargetKeyWhenDefinedOnPrototype

ReflectGetMetadataKeysWithTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:73
Returns void

ReflectGetMetadataKeysWithTargetKeyWhenNotDefined

ReflectGetMetadataKeysWithTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:60
Returns void

ReflectGetMetadataKeysWithoutTargetKeyWhenDefined

ReflectGetMetadataKeysWithoutTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:18
Returns void

ReflectGetMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype

ReflectGetMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:25
Returns void

ReflectGetMetadataKeysWithoutTargetKeyWhenNotDefined

ReflectGetMetadataKeysWithoutTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getmetadatakeys.ts:12
Returns void

"node_modules/reflect-metadata/test/reflect/reflect-getownmetadata"

"node_modules/reflect-metadata/test/reflect/reflect-getownmetadata":

ReflectGetOwnMetadataInvalidTarget

ReflectGetOwnMetadataInvalidTarget(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadata.ts:7
Returns void

ReflectGetOwnMetadataWithTargetKeyWhenDefined

ReflectGetOwnMetadataWithTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadata.ts:38
Returns void

ReflectGetOwnMetadataWithTargetKeyWhenDefinedOnPrototype

ReflectGetOwnMetadataWithTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadata.ts:45
Returns void

ReflectGetOwnMetadataWithTargetKeyWhenNotDefined

ReflectGetOwnMetadataWithTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadata.ts:32
Returns void

ReflectGetOwnMetadataWithoutTargetKeyWhenDefined

ReflectGetOwnMetadataWithoutTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadata.ts:17
Returns void

ReflectGetOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype

ReflectGetOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadata.ts:24
Returns void

ReflectGetOwnMetadataWithoutTargetKeyWhenNotDefined

ReflectGetOwnMetadataWithoutTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadata.ts:11
Returns void

"node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys"

"node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys":

ReflectGetOwnMetadataKeysKeysInvalidTarget

ReflectGetOwnMetadataKeysKeysInvalidTarget(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:7
Returns void

ReflectGetOwnMetadataKeysOrderAfterRedefineWithTargetKey

ReflectGetOwnMetadataKeysOrderAfterRedefineWithTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:71
Returns void

ReflectGetOwnMetadataKeysOrderAfterRedefineWithoutTargetKey

ReflectGetOwnMetadataKeysOrderAfterRedefineWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:41
Returns void

ReflectGetOwnMetadataKeysOrderWithoutTargetKey

ReflectGetOwnMetadataKeysOrderWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:33
Returns void

ReflectGetOwnMetadataKeysWithTargetKeyWhenDefined

ReflectGetOwnMetadataKeysWithTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:56
Returns void

ReflectGetOwnMetadataKeysWithTargetKeyWhenDefinedOnPrototype

ReflectGetOwnMetadataKeysWithTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:63
Returns void

ReflectGetOwnMetadataKeysWithTargetKeyWhenNotDefined

ReflectGetOwnMetadataKeysWithTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:50
Returns void

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefined

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:18
Returns void

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:25
Returns void

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenNotDefined

ReflectGetOwnMetadataKeysWithoutTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-getownmetadatakeys.ts:12
Returns void

"node_modules/reflect-metadata/test/reflect/reflect-hasmetadata"

"node_modules/reflect-metadata/test/reflect/reflect-hasmetadata":

ReflectHasMetadataInvalidTarget

ReflectHasMetadataInvalidTarget(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasmetadata.ts:7
Returns void

ReflectHasMetadataWithTargetKeyWhenDefined

ReflectHasMetadataWithTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasmetadata.ts:38
Returns void

ReflectHasMetadataWithTargetKeyWhenDefinedOnPrototype

ReflectHasMetadataWithTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasmetadata.ts:45
Returns void

ReflectHasMetadataWithTargetKeyWhenNotDefined

ReflectHasMetadataWithTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasmetadata.ts:32
Returns void

ReflectHasMetadataWithoutTargetKeyWhenDefined

ReflectHasMetadataWithoutTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasmetadata.ts:17
Returns void

ReflectHasMetadataWithoutTargetKeyWhenDefinedOnPrototype

ReflectHasMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasmetadata.ts:24
Returns void

ReflectHasMetadataWithoutTargetKeyWhenNotDefined

ReflectHasMetadataWithoutTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasmetadata.ts:11
Returns void

"node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata"

"node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata":

ReflectHasOwnMetadataInvalidTarget

ReflectHasOwnMetadataInvalidTarget(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata.ts:7
Returns void

ReflectHasOwnMetadataWithTargetKeyWhenDefined

ReflectHasOwnMetadataWithTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata.ts:38
Returns void

ReflectHasOwnMetadataWithTargetKeyWhenDefinedOnPrototype

ReflectHasOwnMetadataWithTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata.ts:45
Returns void

ReflectHasOwnMetadataWithTargetKeyWhenNotDefined

ReflectHasOwnMetadataWithTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata.ts:32
Returns void

ReflectHasOwnMetadataWithoutTargetKeyWhenDefined

ReflectHasOwnMetadataWithoutTargetKeyWhenDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata.ts:17
Returns void

ReflectHasOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype

ReflectHasOwnMetadataWithoutTargetKeyWhenDefinedOnPrototype(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata.ts:24
Returns void

ReflectHasOwnMetadataWithoutTargetKeyWhenNotDefined

ReflectHasOwnMetadataWithoutTargetKeyWhenNotDefined(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-hasownmetadata.ts:11
Returns void

"node_modules/reflect-metadata/test/reflect/reflect-metadata"

"node_modules/reflect-metadata/test/reflect/reflect-metadata":

ReflectMetadataDecoratorSetsMetadataOnTargetWithTargetKey

ReflectMetadataDecoratorSetsMetadataOnTargetWithTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-metadata.ts:31
Returns void

ReflectMetadataDecoratorSetsMetadataOnTargetWithoutTargetKey

ReflectMetadataDecoratorSetsMetadataOnTargetWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-metadata.ts:22
Returns void

ReflectMetadataDecoratorThrowsWithInvalidTargetWithTargetKey

ReflectMetadataDecoratorThrowsWithInvalidTargetWithTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-metadata.ts:12
Returns void

ReflectMetadataDecoratorThrowsWithInvalidTargetWithoutTargetKey

ReflectMetadataDecoratorThrowsWithInvalidTargetWithoutTargetKey(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-metadata.ts:17
Returns void

ReflectMetadataReturnsDecoratorFunction

ReflectMetadataReturnsDecoratorFunction(): void

- Defined in node_modules/reflect-metadata/test/reflect/reflect-metadata.ts:7
Returns void

"node_modules/reflect-metadata/test/run"

"node_modules/reflect-metadata/test/run":

results

results: TestResults

"node_modules/reflect-metadata/test/spec"

"node_modules/reflect-metadata/test/spec":

"node_modules/rxjs/src/AsyncSubject"

"node_modules/rxjs/src/AsyncSubject":

AsyncSubject

AsyncSubject:

class: AsyncSubject

constructor

new AsyncSubject(destination?: Observer<T>, source?: Observable<T>): AsyncSubject

Inherited from Subject.constructor

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/Subject.ts:19
Parameters
- Optional destination: Observer<T>
- Optional source: Observable<T>
Returns AsyncSubject

_isScalar

_isScalar: boolean

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

hasNext

hasNext: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

source

source: Observable<T>

value

value: T

if

if: create

throw

throw: create

__computed

__computed(): Subscriber<T>

Inherited from Subject.__computed

Overwrites Observable.__computed
- Defined in node_modules/rxjs/src/Subject.ts:222
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subject._complete
- Defined in node_modules/rxjs/src/AsyncSubject.ts:25
Returns void

_error

_error(err: any): void

Inherited from Subject._error
- Defined in node_modules/rxjs/src/Subject.ts:158
Parameters
- err: any
Returns void

_finalComplete

_finalComplete(): void

Inherited from Subject._finalComplete
- Defined in node_modules/rxjs/src/Subject.ts:195
Returns void

_finalError

_finalError(err: any): void

Inherited from Subject._finalError
- Defined in node_modules/rxjs/src/Subject.ts:166
Parameters
- err: any
Returns void

_finalNext

_finalNext(value: T): void

Inherited from Subject._finalNext
- Defined in node_modules/rxjs/src/Subject.ts:148
Parameters
- value: T
Returns void

_next

_next(value: T): void

Overwrites Subject._next
- Defined in node_modules/rxjs/src/AsyncSubject.ts:20
Parameters
- value: T
Returns void

_subscribe

_subscribe(subscriber: Subscriber<any>): TeardownLogic

Overwrites Subject._subscribe
- Defined in node_modules/rxjs/src/AsyncSubject.ts:12
Parameters
- subscriber: Subscriber<any>
Returns TeardownLogic

_unsubscribe

_unsubscribe(): void

Inherited from Subject._unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:75
Returns void

add

add(subscription: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subject.add
- Defined in node_modules/rxjs/src/Subject.ts:41
Parameters
- subscription: TeardownLogic
Returns Subscription

asObservable

asObservable(): Observable<T>

Inherited from Subject.asObservable
- Defined in node_modules/rxjs/src/Subject.ts:135
Returns Observable<T>

complete

complete(): void

Inherited from Subject.complete
- Defined in node_modules/rxjs/src/Subject.ts:118
Returns void

error

error(err?: any): void

Inherited from Subject.error
- Defined in node_modules/rxjs/src/Subject.ts:100
Parameters
- Optional err: any
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<T, R>(operator: Operator<T, R>): Observable<T>

Inherited from Subject.lift

Overwrites Observable.lift
- Defined in node_modules/rxjs/src/Subject.ts:35
Type parameters
- T
- R
Parameters
- operator: Operator<T, R>
Returns Observable<T>

next(value: T): void

Inherited from Subject.next
- Defined in node_modules/rxjs/src/Subject.ts:82
Parameters
- value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subject.remove
- Defined in node_modules/rxjs/src/Subject.ts:45
Parameters
- subscription: Subscription
Returns void

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subject.unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:49
Returns void

create

create<T>(destination: Observer<T>, source: Observable<T>): Subject<T>

Inherited from Subject.create

Overwrites Observable.create
- Defined in node_modules/rxjs/src/Subject.ts:17
Type parameters
- T
Parameters
- destination: Observer<T>
- source: Observable<T>
Returns Subject<T>

"node_modules/rxjs/src/BehaviorSubject"

"node_modules/rxjs/src/BehaviorSubject":

BehaviorSubject

BehaviorSubject:

class: BehaviorSubject

constructor

new BehaviorSubject(_value: T): BehaviorSubject

Overwrites Subject.constructor
- Defined in node_modules/rxjs/src/BehaviorSubject.ts:10
Parameters
- _value: T
Returns BehaviorSubject

_isScalar

_isScalar: boolean

_value

_value: T

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

source

source: Observable<T>

if

if: create

throw

throw: create

value

value:

__computed

__computed(): Subscriber<T>

Inherited from Subject.__computed

Overwrites Observable.__computed
- Defined in node_modules/rxjs/src/Subject.ts:222
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subject._complete
- Defined in node_modules/rxjs/src/Subject.ts:187
Returns void

_error

_error(err: any): void

Overwrites Subject._error
- Defined in node_modules/rxjs/src/BehaviorSubject.ts:42
Parameters
- err: any
Returns void

_finalComplete

_finalComplete(): void

Inherited from Subject._finalComplete
- Defined in node_modules/rxjs/src/Subject.ts:195
Returns void

_finalError

_finalError(err: any): void

Inherited from Subject._finalError
- Defined in node_modules/rxjs/src/Subject.ts:166
Parameters
- err: any
Returns void

_finalNext

_finalNext(value: T): void

Inherited from Subject._finalNext
- Defined in node_modules/rxjs/src/Subject.ts:148
Parameters
- value: T
Returns void

_next

_next(value: T): void

Overwrites Subject._next
- Defined in node_modules/rxjs/src/BehaviorSubject.ts:38
Parameters
- value: T
Returns void

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Subject._subscribe
- Defined in node_modules/rxjs/src/BehaviorSubject.ts:30
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

_unsubscribe

_unsubscribe(): void

Inherited from Subject._unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:75
Returns void

add

add(subscription: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subject.add
- Defined in node_modules/rxjs/src/Subject.ts:41
Parameters
- subscription: TeardownLogic
Returns Subscription

asObservable

asObservable(): Observable<T>

Inherited from Subject.asObservable
- Defined in node_modules/rxjs/src/Subject.ts:135
Returns Observable<T>

complete

complete(): void

Inherited from Subject.complete
- Defined in node_modules/rxjs/src/Subject.ts:118
Returns void

error

error(err?: any): void

Inherited from Subject.error
- Defined in node_modules/rxjs/src/Subject.ts:100
Parameters
- Optional err: any
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

getValue

getValue(): T

- Defined in node_modules/rxjs/src/BehaviorSubject.ts:16
Returns T

lift

lift<T, R>(operator: Operator<T, R>): Observable<T>

Inherited from Subject.lift

Overwrites Observable.lift
- Defined in node_modules/rxjs/src/Subject.ts:35
Type parameters
- T
- R
Parameters
- operator: Operator<T, R>
Returns Observable<T>

next(value: T): void

Inherited from Subject.next
- Defined in node_modules/rxjs/src/Subject.ts:82
Parameters
- value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subject.remove
- Defined in node_modules/rxjs/src/Subject.ts:45
Parameters
- subscription: Subscription
Returns void

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subject.unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:49
Returns void

create

create<T>(destination: Observer<T>, source: Observable<T>): Subject<T>

Inherited from Subject.create

Overwrites Observable.create
- Defined in node_modules/rxjs/src/Subject.ts:17
Type parameters
- T
Parameters
- destination: Observer<T>
- source: Observable<T>
Returns Subject<T>

"node_modules/rxjs/src/InnerSubscriber"

"node_modules/rxjs/src/InnerSubscriber":

InnerSubscriber

InnerSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new InnerSubscriber(parent: OuterSubscriber<T, R>, outerValue: T, outerIndex: number): InnerSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/InnerSubscriber.ts:10
Parameters
- parent: OuterSubscriber<T, R>
- outerValue: T
- outerIndex: number
Returns InnerSubscriber

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

outerIndex

outerIndex: number

outerValue

outerValue: T

parent

parent: OuterSubscriber<T, R>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/InnerSubscriber.ts:25
Returns void

_error

_error(error: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/InnerSubscriber.ts:20
Parameters
- error: any
Returns void

_next

_next(value: R): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/InnerSubscriber.ts:16
Parameters
- value: R
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: R): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: R
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/MiscJSDoc"

"node_modules/rxjs/src/MiscJSDoc":

ObservableDoc

ObservableDoc:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

create

create<T>(subscribe?: function): Observable<T>

- Defined in node_modules/rxjs/src/MiscJSDoc.ts:68
Creates a new Observable that will execute the specified function when a Subscriber subscribes to it.

Creates an Observable with custom logic given in the subscribe function.

create converts a subscribe function to an actual Observable. This is equivalent to calling the Observable constructor. Write the subscribe function so that it behaves as an Observable: It should invoke the Subscriber's next, error, and complete methods following the Observable Contract. A well-formed Observable must invoke either the Subscriber's complete method exactly once or its error method exactly once, and invoke nothing else thereafter.

Most of the times you should not need to use create because existing creation operators (together with instance combination operators) allow you to create an Observable for most of the use cases. However, create is low-level and is able to create any Observable.

example

Emit three random numbers, then complete. var result = Rx.Observable.create(function (subscriber) { subscriber.next(Math.random()); subscriber.next(Math.random()); subscriber.next(Math.random()); subscriber.complete(); }); result.subscribe(x => console.log(x));

see

empty

see

never

see

of

see

throw

static

true

name

create

owner

Observable

Type parameters
- T
Parameters
- Optional subscribe: function
 - - <R>(subscriber: Subscriber<R>): TeardownLogic
 - Type parameters
 - R
 Parameters
 - subscriber: Subscriber<R>
 Returns TeardownLogic
Returns Observable<T>

An Observable that, when subscribed, will execute the specified function.

ObserverDoc

ObserverDoc:

An interface for a consumer of push-based notifications delivered by an Observable.

interface Observer<T> {
  isUnsubscribed?: boolean;
  next: (value: T) => void;
  error: (err: any) => void;
  complete: () => void;
}

An object conforming to the Observer interface is usually given to the observable.subscribe(observer) method, and the Observable will call the Observer's next(value) method to provide notifications. A well-behaved Observable will call an Observer's complete() method exactly once or the Observer's error(err) method exactly once, as the last notification delivered.

interface
name: Observer
noimport: true

isUnsubscribed

isUnsubscribed: boolean

An optional flag to indicate whether this Observer, when used as a subscriber, has already been unsubscribed from its Observable.

type: {boolean}

complete

complete(): void

- Defined in node_modules/rxjs/src/MiscJSDoc.ts:129
The callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err: any): void

- Defined in node_modules/rxjs/src/MiscJSDoc.ts:120
The callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- err: any
  
  The error exception.
Returns void

next(value: T): void

- Defined in node_modules/rxjs/src/MiscJSDoc.ts:110
The callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- value: T
  
  The next value.
Returns void

SchedulerDoc

SchedulerDoc:

An execution context and a data structure to order tasks and schedule their execution. Provides a notion of (potentially virtual) time, through the now() getter method.

Each unit of work in a Scheduler is called an Action.

interface Scheduler {
  now(): number;
  schedule(work, delay?, state?): Subscription;
  flush(): void;
  active: boolean;
  actions: Action[];
  scheduledId: number;
}

interface
name: Scheduler
noimport: true

actions

actions: Action<any>[]

The queue of scheduled actions as an array.

type: {Action[]}

active

active: boolean

A flag to indicate whether the Scheduler is currently executing a batch of queued actions.

type: {boolean}

scheduledId

scheduledId: number

An internal ID used to track the latest asynchronous task such as those coming from setTimeout, setInterval, requestAnimationFrame, and others.

type: {number}

flush

flush(): void

- Defined in node_modules/rxjs/src/MiscJSDoc.ts:195
Prompt the Scheduler to execute all of its queued actions, therefore clearing its queue.

Returns void

now

now(): number

- Defined in node_modules/rxjs/src/MiscJSDoc.ts:165
A getter method that returns a number representing the current time (at the time this function was called) according to the scheduler's own internal clock.

Returns number

A number that represents the current time. May or may not have a relation to wall-clock time. May or may not refer to a time unit (e.g. milliseconds).

schedule

schedule<T>(work: function, delay?: number, state?: T): Subscription

- Defined in node_modules/rxjs/src/MiscJSDoc.ts:186
Schedules a function, work, for execution. May happen at some point in the future, according to the delay parameter, if specified. May be passed some context object, state, which will be passed to the work function.

The given arguments will be processed an stored as an Action object in a queue of actions.

Type parameters
- T
Parameters
- work: function
  
  A function representing a task, or some unit of work to be executed by the Scheduler.
  - - (state?: T): Subscription | void
    - Parameters
      - Optional state: T
      Returns Subscription | void
- Optional delay: number
- Optional state: T
Returns Subscription

A subscription in order to be able to unsubscribe the scheduled work.

"node_modules/rxjs/src/Notification"

"node_modules/rxjs/src/Notification":

Notification

Notification:

Represents a push-based event or value that an Observable can emit. This class is particularly useful for operators that manage notifications, like materialize, dematerialize, observeOn, and others. Besides wrapping the actual delivered value, it also annotates it with metadata of, for instance, what type of push message it is (next, error, or complete).

see: materialize
see: dematerialize
see: observeOn
class: Notification

constructor

new Notification(kind: string, value?: T, exception?: any): Notification

- Defined in node_modules/rxjs/src/Notification.ts:19
Parameters
- kind: string
- Optional value: T
- Optional exception: any
Returns Notification

exception

exception: any

hasValue

hasValue: boolean

kind

kind: string

value

value: T

completeNotification

completeNotification: Notification<any>

undefinedValueNotification

undefinedValueNotification: Notification<any>

accept

accept(nextOrObserver: PartialObserver | function, error?: function, complete?: function): any

- Defined in node_modules/rxjs/src/Notification.ts:70
Takes an Observer or its individual callback functions, and calls observe or do methods accordingly.

Parameters
- nextOrObserver: PartialObserver | function
  
  An Observer or the next callback.
- Optional error: function
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
- Optional complete: function
  - - (): void
    - Returns void
Returns any

do

do(next: function, error?: function, complete?: function): any

- Defined in node_modules/rxjs/src/Notification.ts:49
Given some Observer callbacks, deliver the value represented by the current Notification to the correctly corresponding callback.

Parameters
- next: function
  
  An Observer next callback.
  - - (value: T): void
    - Parameters
      - value: T
      Returns void
- Optional error: function
  - - (err: any): void
    - Parameters
      - err: any
      Returns void
- Optional complete: function
  - - (): void
    - Returns void
Returns any

observe

observe(observer: PartialObserver): any

- Defined in node_modules/rxjs/src/Notification.ts:30
Delivers to the given observer the value wrapped by this Notification.

Parameters
- observer: PartialObserver
Returns any

toObservable

toObservable(): Observable<T>

- Defined in node_modules/rxjs/src/Notification.ts:83
Returns a simple Observable that just delivers the notification represented by this Notification instance.

Returns Observable<T>

createComplete

createComplete(): Notification<any>

- Defined in node_modules/rxjs/src/Notification.ts:127
A shortcut to create a Notification instance of the type complete.

Returns Notification<any>

The valueless "complete" Notification.

createError

createError<T>(err?: any): Notification<T>

- Defined in node_modules/rxjs/src/Notification.ts:119
A shortcut to create a Notification instance of the type error from a given error.

Type parameters
- T
Parameters
- Optional err: any
Returns Notification<T>

The "error" Notification representing the argument.

createNext

createNext<T>(value: T): Notification<T>

- Defined in node_modules/rxjs/src/Notification.ts:105
A shortcut to create a Notification instance of the type next from a given value.

Type parameters
- T
Parameters
- value: T
 
 The next value.
Returns Notification<T>

The "next" Notification representing the argument.

"node_modules/rxjs/src/Observable"

"node_modules/rxjs/src/Observable":

Observable

Observable:

A representation of any set of values over any amount of time. This the most basic building block of RxJS.

class: Observable

constructor

new Observable(subscribe?: function): Observable

- Defined in node_modules/rxjs/src/Observable.ts:32
constructor

Parameters
- Optional subscribe: function
 
 the function that is called when the Observable is initially subscribed to. This function is given a Subscriber, to which new values can be nexted, or an error method can be called to raise an error, or complete can be called to notify of a successful completion.
 - - <R>(subscriber: Subscriber<R>): TeardownLogic
 - Type parameters
 - R
 Parameters
 - subscriber: Subscriber<R>
 Returns TeardownLogic
Returns Observable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<any>): TeardownLogic

- Defined in node_modules/rxjs/src/Observable.ts:151
Parameters
- subscriber: Subscriber<any>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(subscribe?: function): Observable<T>

- Defined in node_modules/rxjs/src/Observable.ts:57
Creates a new cold Observable by calling the Observable constructor

Type parameters
- T
Parameters
- Optional subscribe: function
 - - <R>(subscriber: Subscriber<R>): TeardownLogic
 - Type parameters
 - R
 Parameters
 - subscriber: Subscriber<R>
 Returns TeardownLogic
Returns Observable<T>

a new cold observable

Subscribable

Subscribable:

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): AnonymousSubscription

- Defined in node_modules/rxjs/src/Observable.ts:13
Parameters
- Optional observerOrNext: PartialObserver | function
- Optional error: function
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  - - (): void
    - Returns void
Returns AnonymousSubscription

ObservableInput

ObservableInput: SubscribableOrPromise | ArrayLike<T>

SubscribableOrPromise

SubscribableOrPromise: Subscribable<T> | Promise<T>

"node_modules/rxjs/src/Observer"

"node_modules/rxjs/src/Observer":

CompletionObserver

CompletionObserver:

complete

complete: function

Type declaration

- (): void
- Returns void

error

error: function

Type declaration

- (err: any): void
- Parameters
  - err: any
  Returns void

isUnsubscribed

isUnsubscribed: boolean

next: function

Type declaration

- (value: T): void
- Parameters
  - value: T
  Returns void

ErrorObserver

ErrorObserver:

complete

complete: function

Type declaration

- (): void
- Returns void

error

error: function

Type declaration

- (err: any): void
- Parameters
  - err: any
  Returns void

isUnsubscribed

isUnsubscribed: boolean

next: function

Type declaration

- (value: T): void
- Parameters
  - value: T
  Returns void

NextObserver

NextObserver:

complete

complete: function

Type declaration

- (): void
- Returns void

error

error: function

Type declaration

- (err: any): void
- Parameters
  - err: any
  Returns void

isUnsubscribed

isUnsubscribed: boolean

next: function

Type declaration

- (value: T): void
- Parameters
  - value: T
  Returns void

Observer

Observer:

complete

complete: function

Type declaration

- (): void
- Returns void

error

error: function

Type declaration

- (err: any): void
- Parameters
  - err: any
  Returns void

isUnsubscribed

isUnsubscribed: boolean

next: function

Type declaration

- (value: T): void
- Parameters
  - value: T
  Returns void

PartialObserver

PartialObserver: NextObserver<T> | ErrorObserver<T> | CompletionObserver<T>

empty

empty: object

isUnsubscribed

isUnsubscribed: boolean

complete

complete(): void

- Defined in node_modules/rxjs/src/Observer.ts:35
Returns void

error

error(err: any): void

- Defined in node_modules/rxjs/src/Observer.ts:34
Parameters
- err: any
Returns void

next(value: any): void

- Defined in node_modules/rxjs/src/Observer.ts:33
Parameters
- value: any
Returns void

"node_modules/rxjs/src/Operator"

"node_modules/rxjs/src/Operator":

Operator

Operator:

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/Operator.ts:4
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

"node_modules/rxjs/src/OuterSubscriber"

"node_modules/rxjs/src/OuterSubscriber":

OuterSubscriber

OuterSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new OuterSubscriber(destinationOrNext?: PartialObserver | function, error?: function, complete?: function): OuterSubscriber

Inherited from Subscriber.constructor

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/Subscriber.ts:43
Parameters
- Optional destinationOrNext: PartialObserver | function
- Optional error: function
  - - (e?: any): void
    - Parameters
      - Optional e: any
      Returns void
- Optional complete: function
  - - (): void
    - Returns void
Returns OuterSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, R>): void

- Defined in node_modules/rxjs/src/OuterSubscriber.ts:20
Parameters
- innerSub: InnerSubscriber<T, R>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

- Defined in node_modules/rxjs/src/OuterSubscriber.ts:10
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/ReplaySubject"

"node_modules/rxjs/src/ReplaySubject":

ReplayEvent

ReplayEvent:

constructor

new ReplayEvent(time: number, value: T): ReplayEvent

- Defined in node_modules/rxjs/src/ReplaySubject.ts:83
Parameters
- time: number
- value: T
Returns ReplayEvent

time

time: number

value

value: T

ReplaySubject

ReplaySubject:

class: ReplaySubject

constructor

new ReplaySubject(bufferSize?: number, windowTime?: number, scheduler?: Scheduler): ReplaySubject

Overwrites Subject.constructor
- Defined in node_modules/rxjs/src/ReplaySubject.ts:15
Parameters
- Default value bufferSize: number = Number.POSITIVE_INFINITY
- Default value windowTime: number = Number.POSITIVE_INFINITY
- Optional scheduler: Scheduler
Returns ReplaySubject

_isScalar

_isScalar: boolean

_windowTime

_windowTime: number

bufferSize

bufferSize: number

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

events

events: ReplayEvent<T>[]

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<T>

if

if: create

throw

throw: create

__computed

__computed(): Subscriber<T>

Inherited from Subject.__computed

Overwrites Observable.__computed
- Defined in node_modules/rxjs/src/Subject.ts:222
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subject._complete
- Defined in node_modules/rxjs/src/Subject.ts:187
Returns void

_error

_error(err: any): void

Inherited from Subject._error
- Defined in node_modules/rxjs/src/Subject.ts:158
Parameters
- err: any
Returns void

_finalComplete

_finalComplete(): void

Inherited from Subject._finalComplete
- Defined in node_modules/rxjs/src/Subject.ts:195
Returns void

_finalError

_finalError(err: any): void

Inherited from Subject._finalError
- Defined in node_modules/rxjs/src/Subject.ts:166
Parameters
- err: any
Returns void

_finalNext

_finalNext(value: T): void

Inherited from Subject._finalNext
- Defined in node_modules/rxjs/src/Subject.ts:148
Parameters
- value: T
Returns void

_getNow

_getNow(): number

- Defined in node_modules/rxjs/src/ReplaySubject.ts:49
Returns number

_next

_next(value: T): void

Overwrites Subject._next
- Defined in node_modules/rxjs/src/ReplaySubject.ts:26
Parameters
- value: T
Returns void

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Subject._subscribe
- Defined in node_modules/rxjs/src/ReplaySubject.ts:33
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

_trimBufferThenGetEvents

_trimBufferThenGetEvents(now: number): ReplayEvent<T>[]

- Defined in node_modules/rxjs/src/ReplaySubject.ts:53
Parameters
- now: number
Returns ReplayEvent<T>[]

_unsubscribe

_unsubscribe(): void

Inherited from Subject._unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:75
Returns void

add

add(subscription: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subject.add
- Defined in node_modules/rxjs/src/Subject.ts:41
Parameters
- subscription: TeardownLogic
Returns Subscription

asObservable

asObservable(): Observable<T>

Inherited from Subject.asObservable
- Defined in node_modules/rxjs/src/Subject.ts:135
Returns Observable<T>

complete

complete(): void

Inherited from Subject.complete
- Defined in node_modules/rxjs/src/Subject.ts:118
Returns void

error

error(err?: any): void

Inherited from Subject.error
- Defined in node_modules/rxjs/src/Subject.ts:100
Parameters
- Optional err: any
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<T, R>(operator: Operator<T, R>): Observable<T>

Inherited from Subject.lift

Overwrites Observable.lift
- Defined in node_modules/rxjs/src/Subject.ts:35
Type parameters
- T
- R
Parameters
- operator: Operator<T, R>
Returns Observable<T>

next(value: T): void

Inherited from Subject.next
- Defined in node_modules/rxjs/src/Subject.ts:82
Parameters
- value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subject.remove
- Defined in node_modules/rxjs/src/Subject.ts:45
Parameters
- subscription: Subscription
Returns void

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subject.unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:49
Returns void

create

create<T>(destination: Observer<T>, source: Observable<T>): Subject<T>

Inherited from Subject.create

Overwrites Observable.create
- Defined in node_modules/rxjs/src/Subject.ts:17
Type parameters
- T
Parameters
- destination: Observer<T>
- source: Observable<T>
Returns Subject<T>

"node_modules/rxjs/src/Rx"

"node_modules/rxjs/src/Rx":

Scheduler

Scheduler: object

typedef: {Object} Rx.Scheduler
property: {Scheduler} queue Schedules on a queue in the current event frame (trampoline scheduler). Use this for iteration operations.
property: {Scheduler} asap Schedules on the micro task queue, which uses the fastest transport mechanism available, either Node.js' process.nextTick() or Web Worker MessageChannel or setTimeout or others. Use this for asynchronous conversions.
property: {Scheduler} async Schedules work with setInterval. Use this for time-based operations.

asap

asap: AsapScheduler

async

async: AsyncScheduler

queue

queue: QueueScheduler

Symbol

Symbol: object

typedef: {Object} Rx.Symbol
property: {Symbol|string} rxSubscriber A symbol to use as a property name to retrieve an "Rx safe" Observer from an object. "Rx safety" can be defined as an object that has all of the traits of an Rx Subscriber, including the ability to add and remove subscriptions to the subscription chain and guarantees involving event triggering (can't "next" after unsubscription, etc).
property: {Symbol|string} observable A symbol to use as a property name to retrieve an Observable as defined by the ECMAScript "Observable" spec.
property: {Symbol|string} iterator The ES6 symbol to use as a property name to retrieve an iterator from an object.

iterator

iterator: any

observable

observable: symbol

rxSubscriber

rxSubscriber: any

"node_modules/rxjs/src/Rx.DOM"

"node_modules/rxjs/src/Rx.DOM":

Scheduler

Scheduler: object

animationFrame

animationFrame: AnimationFrameScheduler

asap

asap: AsapScheduler

async

async: AsyncScheduler

queue

queue: QueueScheduler

"node_modules/rxjs/src/Rx.KitchenSink"

"node_modules/rxjs/src/Rx.KitchenSink":

"node_modules/rxjs/src/Scheduler"

"node_modules/rxjs/src/Scheduler":

Scheduler

Scheduler:

actions

actions: Action<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

flush(): void

- Defined in node_modules/rxjs/src/Scheduler.ts:7
Returns void

now

now(): number

- Defined in node_modules/rxjs/src/Scheduler.ts:5
Returns number

schedule

schedule<T>(work: function, delay?: number, state?: T): Subscription

- Defined in node_modules/rxjs/src/Scheduler.ts:6
Type parameters
- T
Parameters
- work: function
  - - (state?: T): Subscription | void
    - Parameters
      - Optional state: T
      Returns Subscription | void
- Optional delay: number
- Optional state: T
Returns Subscription

"node_modules/rxjs/src/Subject"

"node_modules/rxjs/src/Subject":

Subject

Subject:

class: Subject

constructor

new Subject(destination?: Observer<T>, source?: Observable<T>): Subject

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/Subject.ts:19
Parameters
- Optional destination: Observer<T>
- Optional source: Observable<T>
Returns Subject

_isScalar

_isScalar: boolean

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

source

source: Observable<T>

if

if: create

throw

throw: create

__computed

__computed(): Subscriber<T>

Overwrites Observable.__computed
- Defined in node_modules/rxjs/src/Subject.ts:222
Returns Subscriber<T>

_complete

_complete(): void

- Defined in node_modules/rxjs/src/Subject.ts:187
Returns void

_error

_error(err: any): void

- Defined in node_modules/rxjs/src/Subject.ts:158
Parameters
- err: any
Returns void

_finalComplete

_finalComplete(): void

- Defined in node_modules/rxjs/src/Subject.ts:195
Returns void

_finalError

_finalError(err: any): void

- Defined in node_modules/rxjs/src/Subject.ts:166
Parameters
- err: any
Returns void

_finalNext

_finalNext(value: T): void

- Defined in node_modules/rxjs/src/Subject.ts:148
Parameters
- value: T
Returns void

_next

_next(value: T): void

- Defined in node_modules/rxjs/src/Subject.ts:140
Parameters
- value: T
Returns void

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/Subject.ts:53
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/Subject.ts:75
Returns void

add

add(subscription: TeardownLogic): Subscription

Implementation of ISubscription.add
- Defined in node_modules/rxjs/src/Subject.ts:41
Parameters
- subscription: TeardownLogic
Returns Subscription

asObservable

asObservable(): Observable<T>

- Defined in node_modules/rxjs/src/Subject.ts:135
Returns Observable<T>

complete

complete(): void

- Defined in node_modules/rxjs/src/Subject.ts:118
Returns void

error

error(err?: any): void

- Defined in node_modules/rxjs/src/Subject.ts:100
Parameters
- Optional err: any
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<T, R>(operator: Operator<T, R>): Observable<T>

Overwrites Observable.lift
- Defined in node_modules/rxjs/src/Subject.ts:35
Type parameters
- T
- R
Parameters
- operator: Operator<T, R>
Returns Observable<T>

next(value: T): void

- Defined in node_modules/rxjs/src/Subject.ts:82
Parameters
- value: T
Returns void

remove

remove(subscription: Subscription): void

- Defined in node_modules/rxjs/src/Subject.ts:45
Parameters
- subscription: Subscription
Returns void

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

throwIfUnsubscribed

throwIfUnsubscribed(): void

- Defined in node_modules/rxjs/src/Subject.ts:216
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:49
Returns void

create

create<T>(destination: Observer<T>, source: Observable<T>): Subject<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/Subject.ts:17
Type parameters
- T
Parameters
- destination: Observer<T>
- source: Observable<T>
Returns Subject<T>

SubjectObservable

SubjectObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SubjectObservable(source: Subject<T>): SubjectObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/Subject.ts:232
Parameters
- source: Subject<T>
Returns SubjectObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<any>): TeardownLogic

Inherited from Observable._subscribe
- Defined in node_modules/rxjs/src/Observable.ts:151
Parameters
- subscriber: Subscriber<any>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(subscribe?: function): Observable<T>

Inherited from Observable.create
- Defined in node_modules/rxjs/src/Observable.ts:57
Creates a new cold Observable by calling the Observable constructor

Type parameters
- T
Parameters
- Optional subscribe: function
 - - <R>(subscriber: Subscriber<R>): TeardownLogic
 - Type parameters
 - R
 Parameters
 - subscriber: Subscriber<R>
 Returns TeardownLogic
Returns Observable<T>

a new cold observable

"node_modules/rxjs/src/SubjectSubscription"

"node_modules/rxjs/src/SubjectSubscription":

SubjectSubscription

SubjectSubscription:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SubjectSubscription(subject: Subject<any>, observer: Observer<any>): SubjectSubscription

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/SubjectSubscription.ts:11
Parameters
- subject: Subject<any>
- observer: Observer<any>
Returns SubjectSubscription

isUnsubscribed

isUnsubscribed: boolean

observer

observer: Observer<any>

subject

subject: Subject<any>

EMPTY

EMPTY: Subscription

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/SubjectSubscription.ts:17
Returns void

"node_modules/rxjs/src/Subscriber"

"node_modules/rxjs/src/Subscriber":

SafeSubscriber

SafeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SafeSubscriber(_parent: Subscriber<T>, observerOrNext?: PartialObserver | function, error?: function, complete?: function): SafeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/Subscriber.ts:158
Parameters
- _parent: Subscriber<T>
- Optional observerOrNext: PartialObserver | function
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns SafeSubscriber

_context

_context: any

_parent

_parent: Subscriber<T>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

___tryOrSetError

___tryOrSetError(parent: Subscriber<T>, fn: Function, value?: any): boolean

- Defined in node_modules/rxjs/src/Subscriber.ts:247
Parameters
- parent: Subscriber<T>
- fn: Function
- Optional value: any
Returns boolean

___tryOrUnsub

___tryOrUnsub(fn: Function, value?: any): void

- Defined in node_modules/rxjs/src/Subscriber.ts:238
Parameters
- fn: Function
- Optional value: any
Returns void

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/Subscriber.ts:258
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Overwrites Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:221
Returns void

error

error(err?: any): void

Overwrites Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:199
Parameters
- Optional err: any
Returns void

next(value?: T): void

Overwrites Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:188
Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

Subscriber

Subscriber:

Implements the Observer interface and extends the Subscription class. While the Observer is the public API for consuming the values of an Observable, all Observers get converted to a Subscriber, in order to provide Subscription-like capabilities such as unsubscribe. Subscriber is a common type in RxJS, and crucial for implementing operators, but it is rarely used as a public API.

class: Subscriber

constructor

new Subscriber(destinationOrNext?: PartialObserver | function, error?: function, complete?: function): Subscriber

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/Subscriber.ts:43
Parameters
- Optional destinationOrNext: PartialObserver | function
- Optional error: function
  - - (e?: any): void
    - Parameters
      - Optional e: any
      Returns void
- Optional complete: function
  - - (): void
    - Returns void
Returns Subscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/Subscription"

"node_modules/rxjs/src/Subscription":

Subscription

Subscription:

Represents a disposable resource, such as the execution of an Observable. A Subscription has one important method, unsubscribe, that takes no argument and just disposes the resource held by the subscription.

Additionally, subscriptions may be grouped together through the add() method, which will attach a child Subscription to the current Subscription. When a Subscription is unsubscribed, all its children (and its grandchildren) will be unsubscribed as well.

class: Subscription

constructor

new Subscription(unsubscribe?: function): Subscription

- Defined in node_modules/rxjs/src/Subscription.ts:43
Parameters
- Optional unsubscribe: function
  - - (): void
    - Returns void
Returns Subscription

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

EMPTY

EMPTY: Subscription

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

remove

remove(subscription: Subscription): void

- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscription.ts:61
Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

Returns void

AnonymousSubscription

AnonymousSubscription:

unsubscribe

unsubscribe(): void

- Defined in node_modules/rxjs/src/Subscription.ts:9
Returns void

ISubscription

ISubscription:

isUnsubscribed

isUnsubscribed: boolean

add

add(teardown: TeardownLogic): ISubscription

- Defined in node_modules/rxjs/src/Subscription.ts:17
Parameters
- teardown: TeardownLogic
Returns ISubscription

remove

remove(sub: ISubscription): void

- Defined in node_modules/rxjs/src/Subscription.ts:18
Parameters
- sub: ISubscription
Returns void

unsubscribe

unsubscribe(): void

Overwrites AnonymousSubscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscription.ts:15
Returns void

TeardownLogic

TeardownLogic: AnonymousSubscription | Function | void

"node_modules/rxjs/src/add/observable/bindCallback"

"node_modules/rxjs/src/add/observable/bindCallback":

"../../Observable"

"../../Observable":

Observable

Observable:

bindCallback

bindCallback: create

"node_modules/rxjs/src/add/observable/bindNodeCallback"

"node_modules/rxjs/src/add/observable/bindNodeCallback":

"../../Observable"

"../../Observable":

Observable

Observable:

bindNodeCallback

bindNodeCallback: create

"node_modules/rxjs/src/add/observable/combineLatest"

"node_modules/rxjs/src/add/observable/combineLatest":

"../../Observable"

"../../Observable":

Observable

Observable:

combineLatest

combineLatest: combineLatestStatic

"node_modules/rxjs/src/add/observable/concat"

"node_modules/rxjs/src/add/observable/concat":

"../../Observable"

"../../Observable":

Observable

Observable:

concat

concat: concatStatic

"node_modules/rxjs/src/add/observable/defer"

"node_modules/rxjs/src/add/observable/defer":

"../../Observable"

"../../Observable":

Observable

Observable:

defer

defer: create

"node_modules/rxjs/src/add/observable/dom/ajax"

"node_modules/rxjs/src/add/observable/dom/ajax":

"../../../Observable"

"../../../Observable":

Observable

Observable:

ajax

ajax: AjaxCreationMethod

"node_modules/rxjs/src/add/observable/dom/webSocket"

"node_modules/rxjs/src/add/observable/dom/webSocket":

"../../../Observable"

"../../../Observable":

Observable

Observable:

webSocket

webSocket: create

"node_modules/rxjs/src/add/observable/empty"

"node_modules/rxjs/src/add/observable/empty":

"../../Observable"

"../../Observable":

Observable

Observable:

empty

empty: create

"node_modules/rxjs/src/add/observable/forkJoin"

"node_modules/rxjs/src/add/observable/forkJoin":

"../../Observable"

"../../Observable":

Observable

Observable:

forkJoin

forkJoin: create

"node_modules/rxjs/src/add/observable/from"

"node_modules/rxjs/src/add/observable/from":

"../../Observable"

"../../Observable":

Observable

Observable:

from

from: create

"node_modules/rxjs/src/add/observable/fromEvent"

"node_modules/rxjs/src/add/observable/fromEvent":

"../../Observable"

"../../Observable":

Observable

Observable:

fromEvent

fromEvent: create

"node_modules/rxjs/src/add/observable/fromEventPattern"

"node_modules/rxjs/src/add/observable/fromEventPattern":

"../../Observable"

"../../Observable":

Observable

Observable:

fromEventPattern

fromEventPattern: create

"node_modules/rxjs/src/add/observable/fromPromise"

"node_modules/rxjs/src/add/observable/fromPromise":

"../../Observable"

"../../Observable":

Observable

Observable:

fromPromise

fromPromise: create

"node_modules/rxjs/src/add/observable/if"

"node_modules/rxjs/src/add/observable/if":

"node_modules/rxjs/src/add/observable/interval"

"node_modules/rxjs/src/add/observable/interval":

"../../Observable"

"../../Observable":

Observable

Observable:

interval

interval: create

"node_modules/rxjs/src/add/observable/merge"

"node_modules/rxjs/src/add/observable/merge":

"../../Observable"

"../../Observable":

Observable

Observable:

merge

merge: mergeStatic

"node_modules/rxjs/src/add/observable/never"

"node_modules/rxjs/src/add/observable/never":

"../../Observable"

"../../Observable":

Observable

Observable:

never

never: create

"node_modules/rxjs/src/add/observable/of"

"node_modules/rxjs/src/add/observable/of":

"../../Observable"

"../../Observable":

Observable

Observable:

of

of: of

"node_modules/rxjs/src/add/observable/race"

"node_modules/rxjs/src/add/observable/race":

"../../Observable"

"../../Observable":

Observable

Observable:

race

race: raceStatic

"node_modules/rxjs/src/add/observable/range"

"node_modules/rxjs/src/add/observable/range":

"../../Observable"

"../../Observable":

Observable

Observable:

range

range: create

"node_modules/rxjs/src/add/observable/throw"

"node_modules/rxjs/src/add/observable/throw":

"node_modules/rxjs/src/add/observable/timer"

"node_modules/rxjs/src/add/observable/timer":

"../../Observable"

"../../Observable":

Observable

Observable:

timer

timer: create

"node_modules/rxjs/src/add/observable/using"

"node_modules/rxjs/src/add/observable/using":

"../../Observable"

"../../Observable":

Observable

Observable:

using

using: create

"node_modules/rxjs/src/add/observable/zip"

"node_modules/rxjs/src/add/observable/zip":

"../../Observable"

"../../Observable":

Observable

Observable:

zip

zip: zipStatic

"node_modules/rxjs/src/add/operator/audit"

"node_modules/rxjs/src/add/operator/audit":

"../../Observable"

"../../Observable":

Observable

Observable:

audit

audit: AuditSignature<T>

"node_modules/rxjs/src/add/operator/auditTime"

"node_modules/rxjs/src/add/operator/auditTime":

"../../Observable"

"../../Observable":

Observable

Observable:

auditTime

auditTime: AuditTimeSignature<T>

"node_modules/rxjs/src/add/operator/buffer"

"node_modules/rxjs/src/add/operator/buffer":

"../../Observable"

"../../Observable":

Observable

Observable:

buffer

buffer: BufferSignature<T>

"node_modules/rxjs/src/add/operator/bufferCount"

"node_modules/rxjs/src/add/operator/bufferCount":

"../../Observable"

"../../Observable":

Observable

Observable:

bufferCount

bufferCount: BufferCountSignature<T>

"node_modules/rxjs/src/add/operator/bufferTime"

"node_modules/rxjs/src/add/operator/bufferTime":

"../../Observable"

"../../Observable":

Observable

Observable:

bufferTime

bufferTime: BufferTimeSignature<T>

"node_modules/rxjs/src/add/operator/bufferToggle"

"node_modules/rxjs/src/add/operator/bufferToggle":

"../../Observable"

"../../Observable":

Observable

Observable:

bufferToggle

bufferToggle: BufferToggleSignature<T>

"node_modules/rxjs/src/add/operator/bufferWhen"

"node_modules/rxjs/src/add/operator/bufferWhen":

"../../Observable"

"../../Observable":

Observable

Observable:

bufferWhen

bufferWhen: BufferWhenSignature<T>

"node_modules/rxjs/src/add/operator/cache"

"node_modules/rxjs/src/add/operator/cache":

"../../Observable"

"../../Observable":

Observable

Observable:

cache

cache: CacheSignature<T>

"node_modules/rxjs/src/add/operator/catch"

"node_modules/rxjs/src/add/operator/catch":

"../../Observable"

"../../Observable":

Observable

Observable:

catch

catch: CatchSignature<T>

"node_modules/rxjs/src/add/operator/combineAll"

"node_modules/rxjs/src/add/operator/combineAll":

"../../Observable"

"../../Observable":

Observable

Observable:

combineAll

combineAll: CombineAllSignature<T>

"node_modules/rxjs/src/add/operator/combineLatest"

"node_modules/rxjs/src/add/operator/combineLatest":

"../../Observable"

"../../Observable":

Observable

Observable:

combineLatest

combineLatest: CombineLatestSignature<T>

"node_modules/rxjs/src/add/operator/concat"

"node_modules/rxjs/src/add/operator/concat":

"../../Observable"

"../../Observable":

Observable

Observable:

concat

concat: ConcatSignature<T>

"node_modules/rxjs/src/add/operator/concatAll"

"node_modules/rxjs/src/add/operator/concatAll":

"../../Observable"

"../../Observable":

Observable

Observable:

concatAll

concatAll: ConcatAllSignature<T>

"node_modules/rxjs/src/add/operator/concatMap"

"node_modules/rxjs/src/add/operator/concatMap":

"../../Observable"

"../../Observable":

Observable

Observable:

concatMap

concatMap: ConcatMapSignature<T>

"node_modules/rxjs/src/add/operator/concatMapTo"

"node_modules/rxjs/src/add/operator/concatMapTo":

"../../Observable"

"../../Observable":

Observable

Observable:

concatMapTo

concatMapTo: ConcatMapToSignature<T>

"node_modules/rxjs/src/add/operator/count"

"node_modules/rxjs/src/add/operator/count":

"../../Observable"

"../../Observable":

Observable

Observable:

count

"node_modules/rxjs/src/add/operator/debounce"

"node_modules/rxjs/src/add/operator/debounce":

"../../Observable"

"../../Observable":

Observable

Observable:

debounce

debounce: DebounceSignature<T>

"node_modules/rxjs/src/add/operator/debounceTime"

"node_modules/rxjs/src/add/operator/debounceTime":

"../../Observable"

"../../Observable":

Observable

Observable:

debounceTime

debounceTime: DebounceTimeSignature<T>

"node_modules/rxjs/src/add/operator/defaultIfEmpty"

"node_modules/rxjs/src/add/operator/defaultIfEmpty":

"../../Observable"

"../../Observable":

Observable

Observable:

defaultIfEmpty

defaultIfEmpty: DefaultIfEmptySignature<T>

"node_modules/rxjs/src/add/operator/delay"

"node_modules/rxjs/src/add/operator/delay":

"../../Observable"

"../../Observable":

Observable

Observable:

delay

delay: DelaySignature<T>

"node_modules/rxjs/src/add/operator/delayWhen"

"node_modules/rxjs/src/add/operator/delayWhen":

"../../Observable"

"../../Observable":

Observable

Observable:

delayWhen

delayWhen: DelayWhenSignature<T>

"node_modules/rxjs/src/add/operator/dematerialize"

"node_modules/rxjs/src/add/operator/dematerialize":

"../../Observable"

"../../Observable":

Observable

Observable:

dematerialize

dematerialize: DematerializeSignature<T>

"node_modules/rxjs/src/add/operator/distinct"

"node_modules/rxjs/src/add/operator/distinct":

"../../Observable"

"../../Observable":

Observable

Observable:

distinct

distinct: DistinctSignature<T>

"node_modules/rxjs/src/add/operator/distinctKey"

"node_modules/rxjs/src/add/operator/distinctKey":

"../../Observable"

"../../Observable":

Observable

Observable:

distinctKey

distinctKey: DistinctKeySignature<T>

"node_modules/rxjs/src/add/operator/distinctUntilChanged"

"node_modules/rxjs/src/add/operator/distinctUntilChanged":

"../../Observable"

"../../Observable":

Observable

Observable:

distinctUntilChanged

distinctUntilChanged: DistinctUntilChangedSignature<T>

"node_modules/rxjs/src/add/operator/distinctUntilKeyChanged"

"node_modules/rxjs/src/add/operator/distinctUntilKeyChanged":

"../../Observable"

"../../Observable":

Observable

Observable:

distinctUntilKeyChanged

distinctUntilKeyChanged: DistinctUntilKeyChangedSignature<T>

"node_modules/rxjs/src/add/operator/do"

"node_modules/rxjs/src/add/operator/do":

"../../Observable"

"../../Observable":

Observable

Observable:

do

do: DoSignature<T>

"node_modules/rxjs/src/add/operator/elementAt"

"node_modules/rxjs/src/add/operator/elementAt":

"../../Observable"

"../../Observable":

Observable

Observable:

elementAt

elementAt: ElementAtSignature<T>

"node_modules/rxjs/src/add/operator/every"

"node_modules/rxjs/src/add/operator/every":

"../../Observable"

"../../Observable":

Observable

Observable:

every

every: EverySignature<T>

"node_modules/rxjs/src/add/operator/exhaust"

"node_modules/rxjs/src/add/operator/exhaust":

"../../Observable"

"../../Observable":

Observable

Observable:

exhaust

exhaust: SwitchFirstSignature<T>

"node_modules/rxjs/src/add/operator/exhaustMap"

"node_modules/rxjs/src/add/operator/exhaustMap":

"../../Observable"

"../../Observable":

Observable

Observable:

exhaustMap

exhaustMap: SwitchFirstMapSignature<T>

"node_modules/rxjs/src/add/operator/expand"

"node_modules/rxjs/src/add/operator/expand":

"../../Observable"

"../../Observable":

Observable

Observable:

expand

expand: ExpandSignature<T>

"node_modules/rxjs/src/add/operator/filter"

"node_modules/rxjs/src/add/operator/filter":

"../../Observable"

"../../Observable":

Observable

Observable:

filter

filter: FilterSignature<T>

"node_modules/rxjs/src/add/operator/finally"

"node_modules/rxjs/src/add/operator/finally":

"../../Observable"

"../../Observable":

Observable

Observable:

finally

finally: FinallySignature<T>

"node_modules/rxjs/src/add/operator/find"

"node_modules/rxjs/src/add/operator/find":

"../../Observable"

"../../Observable":

Observable

Observable:

find

find: FindSignature<T>

"node_modules/rxjs/src/add/operator/findIndex"

"node_modules/rxjs/src/add/operator/findIndex":

"../../Observable"

"../../Observable":

Observable

Observable:

findIndex

findIndex: FindIndexSignature<T>

"node_modules/rxjs/src/add/operator/first"

"node_modules/rxjs/src/add/operator/first":

"../../Observable"

"../../Observable":

Observable

Observable:

first

first: FirstSignature<T>

"node_modules/rxjs/src/add/operator/groupBy"

"node_modules/rxjs/src/add/operator/groupBy":

"../../Observable"

"../../Observable":

Observable

Observable:

groupBy

groupBy: GroupBySignature<T>

"node_modules/rxjs/src/add/operator/ignoreElements"

"node_modules/rxjs/src/add/operator/ignoreElements":

"../../Observable"

"../../Observable":

Observable

Observable:

ignoreElements

ignoreElements: IgnoreElementsSignature<T>

"node_modules/rxjs/src/add/operator/isEmpty"

"node_modules/rxjs/src/add/operator/isEmpty":

"../../Observable"

"../../Observable":

Observable

Observable:

isEmpty

isEmpty: IsEmptySignature<T>

"node_modules/rxjs/src/add/operator/last"

"node_modules/rxjs/src/add/operator/last":

"../../Observable"

"../../Observable":

Observable

Observable:

last

last: LastSignature<T>

"node_modules/rxjs/src/add/operator/let"

"node_modules/rxjs/src/add/operator/let":

"../../Observable"

"../../Observable":

Observable

Observable:

let

let: LetSignature<T>

letBind

letBind: LetSignature<T>

"node_modules/rxjs/src/add/operator/map"

"node_modules/rxjs/src/add/operator/map":

"../../Observable"

"../../Observable":

Observable

Observable:

map

map: MapSignature<T>

"node_modules/rxjs/src/add/operator/mapTo"

"node_modules/rxjs/src/add/operator/mapTo":

"../../Observable"

"../../Observable":

Observable

Observable:

mapTo

mapTo: MapToSignature<T>

"node_modules/rxjs/src/add/operator/materialize"

"node_modules/rxjs/src/add/operator/materialize":

"../../Observable"

"../../Observable":

Observable

Observable:

materialize

materialize: MaterializeSignature<T>

"node_modules/rxjs/src/add/operator/max"

"node_modules/rxjs/src/add/operator/max":

"../../Observable"

"../../Observable":

Observable

Observable:

max

max: MaxSignature<T>

"node_modules/rxjs/src/add/operator/merge"

"node_modules/rxjs/src/add/operator/merge":

"../../Observable"

"../../Observable":

Observable

Observable:

merge

merge: MergeSignature<T>

"node_modules/rxjs/src/add/operator/mergeAll"

"node_modules/rxjs/src/add/operator/mergeAll":

"../../Observable"

"../../Observable":

Observable

Observable:

mergeAll

mergeAll: MergeAllSignature<T>

"node_modules/rxjs/src/add/operator/mergeMap"

"node_modules/rxjs/src/add/operator/mergeMap":

"../../Observable"

"../../Observable":

Observable

Observable:

flatMap

flatMap: MergeMapSignature<T>

mergeMap

mergeMap: MergeMapSignature<T>

"node_modules/rxjs/src/add/operator/mergeMapTo"

"node_modules/rxjs/src/add/operator/mergeMapTo":

"../../Observable"

"../../Observable":

Observable

Observable:

flatMapTo

flatMapTo: MergeMapToSignature<T>

mergeMapTo

mergeMapTo: MergeMapToSignature<T>

"node_modules/rxjs/src/add/operator/mergeScan"

"node_modules/rxjs/src/add/operator/mergeScan":

"../../Observable"

"../../Observable":

Observable

Observable:

mergeScan

mergeScan: MergeScanSignature<T>

"node_modules/rxjs/src/add/operator/min"

"node_modules/rxjs/src/add/operator/min":

"../../Observable"

"../../Observable":

Observable

Observable:

min

min: MinSignature<T>

"node_modules/rxjs/src/add/operator/multicast"

"node_modules/rxjs/src/add/operator/multicast":

"../../Observable"

"../../Observable":

Observable

Observable:

multicast

multicast: MulticastSignature<T>

"node_modules/rxjs/src/add/operator/observeOn"

"node_modules/rxjs/src/add/operator/observeOn":

"../../Observable"

"../../Observable":

Observable

Observable:

observeOn

observeOn: ObserveOnSignature<T>

"node_modules/rxjs/src/add/operator/pairwise"

"node_modules/rxjs/src/add/operator/pairwise":

"../../Observable"

"../../Observable":

Observable

Observable:

pairwise

pairwise: PairwiseSignature<T>

"node_modules/rxjs/src/add/operator/partition"

"node_modules/rxjs/src/add/operator/partition":

"../../Observable"

"../../Observable":

Observable

Observable:

partition

partition: PartitionSignature<T>

"node_modules/rxjs/src/add/operator/pluck"

"node_modules/rxjs/src/add/operator/pluck":

"../../Observable"

"../../Observable":

Observable

Observable:

pluck

pluck: PluckSignature<T>

"node_modules/rxjs/src/add/operator/publish"

"node_modules/rxjs/src/add/operator/publish":

"../../Observable"

"../../Observable":

Observable

Observable:

publish

publish: PublishSignature<T>

"node_modules/rxjs/src/add/operator/publishBehavior"

"node_modules/rxjs/src/add/operator/publishBehavior":

"../../Observable"

"../../Observable":

Observable

Observable:

publishBehavior

publishBehavior: PublishBehaviorSignature<T>

"node_modules/rxjs/src/add/operator/publishLast"

"node_modules/rxjs/src/add/operator/publishLast":

"../../Observable"

"../../Observable":

Observable

Observable:

publishLast

publishLast: PublishLastSignature<T>

"node_modules/rxjs/src/add/operator/publishReplay"

"node_modules/rxjs/src/add/operator/publishReplay":

"../../Observable"

"../../Observable":

Observable

Observable:

publishReplay

publishReplay: PublishReplaySignature<T>

"node_modules/rxjs/src/add/operator/race"

"node_modules/rxjs/src/add/operator/race":

"../../Observable"

"../../Observable":

Observable

Observable:

race

race: RaceSignature<T>

"node_modules/rxjs/src/add/operator/reduce"

"node_modules/rxjs/src/add/operator/reduce":

"../../Observable"

"../../Observable":

Observable

Observable:

reduce

reduce: ReduceSignature<T>

"node_modules/rxjs/src/add/operator/repeat"

"node_modules/rxjs/src/add/operator/repeat":

"../../Observable"

"../../Observable":

Observable

Observable:

repeat

repeat: RepeatSignature<T>

"node_modules/rxjs/src/add/operator/retry"

"node_modules/rxjs/src/add/operator/retry":

"../../Observable"

"../../Observable":

Observable

Observable:

retry

retry: RetrySignature<T>

"node_modules/rxjs/src/add/operator/retryWhen"

"node_modules/rxjs/src/add/operator/retryWhen":

"../../Observable"

"../../Observable":

Observable

Observable:

retryWhen

retryWhen: RetryWhenSignature<T>

"node_modules/rxjs/src/add/operator/sample"

"node_modules/rxjs/src/add/operator/sample":

"../../Observable"

"../../Observable":

Observable

Observable:

sample

sample: SampleSignature<T>

"node_modules/rxjs/src/add/operator/sampleTime"

"node_modules/rxjs/src/add/operator/sampleTime":

"../../Observable"

"../../Observable":

Observable

Observable:

sampleTime

sampleTime: SampleTimeSignature<T>

"node_modules/rxjs/src/add/operator/scan"

"node_modules/rxjs/src/add/operator/scan":

"../../Observable"

"../../Observable":

Observable

Observable:

scan

scan: ScanSignature<T>

"node_modules/rxjs/src/add/operator/share"

"node_modules/rxjs/src/add/operator/share":

"../../Observable"

"../../Observable":

Observable

Observable:

share: ShareSignature<T>

"node_modules/rxjs/src/add/operator/single"

"node_modules/rxjs/src/add/operator/single":

"../../Observable"

"../../Observable":

Observable

Observable:

single

single: SingleSignature<T>

"node_modules/rxjs/src/add/operator/skip"

"node_modules/rxjs/src/add/operator/skip":

"../../Observable"

"../../Observable":

Observable

Observable:

skip

skip: SkipSignature<T>

"node_modules/rxjs/src/add/operator/skipUntil"

"node_modules/rxjs/src/add/operator/skipUntil":

"../../Observable"

"../../Observable":

Observable

Observable:

skipUntil

skipUntil: SkipUntilSignature<T>

"node_modules/rxjs/src/add/operator/skipWhile"

"node_modules/rxjs/src/add/operator/skipWhile":

"../../Observable"

"../../Observable":

Observable

Observable:

skipWhile

skipWhile: SkipWhileSignature<T>

"node_modules/rxjs/src/add/operator/startWith"

"node_modules/rxjs/src/add/operator/startWith":

"../../Observable"

"../../Observable":

Observable

Observable:

startWith

startWith: StartWithSignature<T>

"node_modules/rxjs/src/add/operator/subscribeOn"

"node_modules/rxjs/src/add/operator/subscribeOn":

"../../Observable"

"../../Observable":

Observable

Observable:

subscribeOn

subscribeOn: SubscribeOnSignature<T>

"node_modules/rxjs/src/add/operator/switch"

"node_modules/rxjs/src/add/operator/switch":

"../../Observable"

"../../Observable":

Observable

Observable:

switch

switch: SwitchSignature<T>

"node_modules/rxjs/src/add/operator/switchMap"

"node_modules/rxjs/src/add/operator/switchMap":

"../../Observable"

"../../Observable":

Observable

Observable:

switchMap

switchMap: SwitchMapSignature<T>

"node_modules/rxjs/src/add/operator/switchMapTo"

"node_modules/rxjs/src/add/operator/switchMapTo":

"../../Observable"

"../../Observable":

Observable

Observable:

switchMapTo

switchMapTo: SwitchMapToSignature<T>

"node_modules/rxjs/src/add/operator/take"

"node_modules/rxjs/src/add/operator/take":

"../../Observable"

"../../Observable":

Observable

Observable:

take

take: TakeSignature<T>

"node_modules/rxjs/src/add/operator/takeLast"

"node_modules/rxjs/src/add/operator/takeLast":

"../../Observable"

"../../Observable":

Observable

Observable:

takeLast

takeLast: TakeLastSignature<T>

"node_modules/rxjs/src/add/operator/takeUntil"

"node_modules/rxjs/src/add/operator/takeUntil":

"../../Observable"

"../../Observable":

Observable

Observable:

takeUntil

takeUntil: TakeUntilSignature<T>

"node_modules/rxjs/src/add/operator/takeWhile"

"node_modules/rxjs/src/add/operator/takeWhile":

"../../Observable"

"../../Observable":

Observable

Observable:

takeWhile

takeWhile: TakeWhileSignature<T>

"node_modules/rxjs/src/add/operator/throttle"

"node_modules/rxjs/src/add/operator/throttle":

"../../Observable"

"../../Observable":

Observable

Observable:

throttle

throttle: ThrottleSignature<T>

"node_modules/rxjs/src/add/operator/throttleTime"

"node_modules/rxjs/src/add/operator/throttleTime":

"../../Observable"

"../../Observable":

Observable

Observable:

throttleTime

throttleTime: ThrottleTimeSignature<T>

"node_modules/rxjs/src/add/operator/timeInterval"

"node_modules/rxjs/src/add/operator/timeInterval":

"../../Observable"

"../../Observable":

Observable

Observable:

timeInterval

timeInterval: TimeIntervalSignature<T>

"node_modules/rxjs/src/add/operator/timeout"

"node_modules/rxjs/src/add/operator/timeout":

"../../Observable"

"../../Observable":

Observable

Observable:

timeout

timeout: TimeoutSignature<T>

"node_modules/rxjs/src/add/operator/timeoutWith"

"node_modules/rxjs/src/add/operator/timeoutWith":

"../../Observable"

"../../Observable":

Observable

Observable:

timeoutWith

timeoutWith: TimeoutWithSignature<T>

"node_modules/rxjs/src/add/operator/timestamp"

"node_modules/rxjs/src/add/operator/timestamp":

"../../Observable"

"../../Observable":

Observable

Observable:

timestamp

timestamp: TimestampSignature<T>

"node_modules/rxjs/src/add/operator/toArray"

"node_modules/rxjs/src/add/operator/toArray":

"../../Observable"

"../../Observable":

Observable

Observable:

toArray

toArray: ToArraySignature<T>

"node_modules/rxjs/src/add/operator/toPromise"

"node_modules/rxjs/src/add/operator/toPromise":

"../../Observable"

"../../Observable":

Observable

Observable:

toPromise

toPromise: ToPromiseSignature<T>

"node_modules/rxjs/src/add/operator/window"

"node_modules/rxjs/src/add/operator/window":

"../../Observable"

"../../Observable":

Observable

Observable:

window

window: WindowSignature<T>

"node_modules/rxjs/src/add/operator/windowCount"

"node_modules/rxjs/src/add/operator/windowCount":

"../../Observable"

"../../Observable":

Observable

Observable:

windowCount

windowCount: WindowCountSignature<T>

"node_modules/rxjs/src/add/operator/windowTime"

"node_modules/rxjs/src/add/operator/windowTime":

"../../Observable"

"../../Observable":

Observable

Observable:

windowTime

windowTime: WindowTimeSignature<T>

"node_modules/rxjs/src/add/operator/windowToggle"

"node_modules/rxjs/src/add/operator/windowToggle":

"../../Observable"

"../../Observable":

Observable

Observable:

windowToggle

windowToggle: WindowToggleSignature<T>

"node_modules/rxjs/src/add/operator/windowWhen"

"node_modules/rxjs/src/add/operator/windowWhen":

"../../Observable"

"../../Observable":

Observable

Observable:

windowWhen

windowWhen: WindowWhenSignature<T>

"node_modules/rxjs/src/add/operator/withLatestFrom"

"node_modules/rxjs/src/add/operator/withLatestFrom":

"../../Observable"

"../../Observable":

Observable

Observable:

withLatestFrom

withLatestFrom: WithLatestFromSignature<T>

"node_modules/rxjs/src/add/operator/zip"

"node_modules/rxjs/src/add/operator/zip":

"../../Observable"

"../../Observable":

Observable

Observable:

zip

zip: ZipSignature<T>

"node_modules/rxjs/src/add/operator/zipAll"

"node_modules/rxjs/src/add/operator/zipAll":

"../../Observable"

"../../Observable":

Observable

Observable:

zipAll

zipAll: ZipAllSignature<T>

"node_modules/rxjs/src/observable/ArrayLikeObservable"

"node_modules/rxjs/src/observable/ArrayLikeObservable":

ArrayLikeObservable

ArrayLikeObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new ArrayLikeObservable(arrayLike: ArrayLike<T>, mapFn: function, thisArg: any, scheduler?: Scheduler): ArrayLikeObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/ArrayLikeObservable.ts:49
Parameters
- arrayLike: ArrayLike<T>
- mapFn: function
 - - (x: T, y: number): T
 - Parameters
 - x: T
 - y: number
 Returns T
- thisArg: any
- Optional scheduler: Scheduler
Returns ArrayLikeObservable

_isScalar

_isScalar: boolean

arrayLike

arrayLike: ArrayLike<T>

mapFn

mapFn: function

Type declaration

- (x: T, y: number): T
- Parameters
  - x: T
  - y: number
  Returns T

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

value

value: any

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/ArrayLikeObservable.ts:62
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(arrayLike: ArrayLike<T>, mapFn: function, thisArg: any, scheduler?: Scheduler): Observable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/ArrayLikeObservable.ts:17
Type parameters
- T
Parameters
- arrayLike: ArrayLike<T>
- mapFn: function
 - - (x: T, y: number): T
 - Parameters
 - x: T
 - y: number
 Returns T
- thisArg: any
- Optional scheduler: Scheduler
Returns Observable<T>

dispatch

dispatch(state: any): void

- Defined in node_modules/rxjs/src/observable/ArrayLikeObservable.ts:28
Parameters
- state: any
Returns void

"node_modules/rxjs/src/observable/ArrayObservable"

"node_modules/rxjs/src/observable/ArrayObservable":

ArrayObservable

ArrayObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new ArrayObservable(array: T[], scheduler?: Scheduler): ArrayObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:102
Parameters
- array: T[]
- Optional scheduler: Scheduler
Returns ArrayObservable

_isScalar

_isScalar: boolean

array

array: T[]

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

value

value: any

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:112
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(array: T[], scheduler?: Scheduler): Observable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:16
Type parameters
- T
Parameters
- array: T[]
- Optional scheduler: Scheduler
Returns Observable<T>

dispatch

dispatch(state: any): void

- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:81
Parameters
- state: any
Returns void

of

of<T>(item1: T, scheduler?: Scheduler): Observable<T>
of<T>(item1: T, item2: T, scheduler?: Scheduler): Observable<T>
of<T>(item1: T, item2: T, item3: T, scheduler?: Scheduler): Observable<T>
of<T>(item1: T, item2: T, item3: T, item4: T, scheduler?: Scheduler): Observable<T>
of<T>(item1: T, item2: T, item3: T, item4: T, item5: T, scheduler?: Scheduler): Observable<T>
of<T>(item1: T, item2: T, item3: T, item4: T, item5: T, item6: T, scheduler?: Scheduler): Observable<T>
of<T>(...array: Array<T | Scheduler>): Observable<T>

- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:20
Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

Emits the arguments you provide, then completes.

This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

Type parameters
- T
Parameters
- item1: T
- Optional scheduler: Scheduler
Returns Observable<T>

An Observable that emits each given input value.
- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:21
Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

Emits the arguments you provide, then completes.

This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

Type parameters
- T
Parameters
- item1: T
- item2: T
- Optional scheduler: Scheduler
Returns Observable<T>

An Observable that emits each given input value.
- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:22
Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

Emits the arguments you provide, then completes.

This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

Type parameters
- T
Parameters
- item1: T
- item2: T
- item3: T
- Optional scheduler: Scheduler
Returns Observable<T>

An Observable that emits each given input value.
- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:23
Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

Emits the arguments you provide, then completes.

This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

Type parameters
- T
Parameters
- item1: T
- item2: T
- item3: T
- item4: T
- Optional scheduler: Scheduler
Returns Observable<T>

An Observable that emits each given input value.
- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:24
Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

Emits the arguments you provide, then completes.

This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

Type parameters
- T
Parameters
- item1: T
- item2: T
- item3: T
- item4: T
- item5: T
- Optional scheduler: Scheduler
Returns Observable<T>

An Observable that emits each given input value.
- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:25
Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

Emits the arguments you provide, then completes.

This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

Type parameters
- T
Parameters
- item1: T
- item2: T
- item3: T
- item4: T
- item5: T
- item6: T
- Optional scheduler: Scheduler
Returns Observable<T>

An Observable that emits each given input value.
- Defined in node_modules/rxjs/src/observable/ArrayObservable.ts:26
Creates an Observable that emits some values you specify as arguments, immediately one after the other, and then emits a complete notification.

Emits the arguments you provide, then completes.

This static operator is useful for creating a simple Observable that only emits the arguments given, and the complete notification thereafter. It can be used for composing with other Observables, such as with concat. By default, it uses a null Scheduler, which means the next notifications are sent synchronously, although with a different Scheduler it is possible to determine when those notifications will be delivered.

Type parameters
- T
Parameters
- Rest ...array: Array<T | Scheduler>
Returns Observable<T>

An Observable that emits each given input value.

"node_modules/rxjs/src/observable/BoundCallbackObservable"

"node_modules/rxjs/src/observable/BoundCallbackObservable":

BoundCallbackObservable

BoundCallbackObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new BoundCallbackObservable(callbackFunc: Function, selector: Function, args: any[], scheduler: Scheduler): BoundCallbackObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:56
Parameters
- callbackFunc: Function
- selector: Function
- args: any[]
- scheduler: Scheduler
Returns BoundCallbackObservable

_isScalar

_isScalar: boolean

args

args: any[]

callbackFunc

callbackFunc: Function

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

selector

selector: Function

source

source: Observable<any>

subject

subject: AsyncSubject<T>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T | T[]>): Subscription

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:65
Parameters
- subscriber: Subscriber<T | T[]>
Returns Subscription

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, T3, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, T3, T4, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, T3, T4, T5, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, T3, T4, T5, T6, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
create<T, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
create<T, T2, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
create<T, T2, T3, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
create<T, T2, T3, T4, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
create<T, T2, T3, T4, T5, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
create<T, T2, T3, T4, T5, T6, R>(callbackFunc: function, selector: function, scheduler?: Scheduler): function
create<T>(callbackFunc: Function, selector?: void, scheduler?: Scheduler): function
create<T>(callbackFunc: Function, selector?: function, scheduler?: Scheduler): function

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:18
Converts a callback function to an observable sequence.

Type parameters
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (callback: function): any
 - Parameters
 - callback: function
 
 (result: R): any
 
 Parameters
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (): Observable<R>
 - Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:19
Converts a callback function to an observable sequence.

Type parameters
- T
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, callback: function): any
 - Parameters
 - v1: T
 - callback: function
 
 (result: R): any
 
 Parameters
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T): Observable<R>
 - Parameters
 - v1: T
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:20
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - callback: function
 
 (result: R): any
 
 Parameters
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:21
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- T3
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, v3: T3, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - callback: function
 
 (result: R): any
 
 Parameters
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2, v3: T3): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:22
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- T3
- T4
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, v3: T3, v4: T4, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - callback: function
 
 (result: R): any
 
 Parameters
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2, v3: T3, v4: T4): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:23
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- T3
- T4
- T5
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - callback: function
 
 (result: R): any
 
 Parameters
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:24
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- T3
- T4
- T5
- T6
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 - callback: function
 
 (result: R): any
 
 Parameters
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:25
Converts a callback function to an observable sequence.

Type parameters
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (callback: function): any
 - Parameters
 - callback: function
 
 (...args: any[]): any
 
 Parameters
 
 Rest ...args: any[]
 
 Returns any
 Returns any
- selector: function
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
 - - (...args: any[]): R
 - Parameters
 - Rest ...args: any[]
 Returns R
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (): Observable<R>
 - Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:26
Converts a callback function to an observable sequence.

Type parameters
- T
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, callback: function): any
 - Parameters
 - v1: T
 - callback: function
 
 (...args: any[]): any
 
 Parameters
 
 Rest ...args: any[]
 
 Returns any
 Returns any
- selector: function
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
 - - (...args: any[]): R
 - Parameters
 - Rest ...args: any[]
 Returns R
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T): Observable<R>
 - Parameters
 - v1: T
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:27
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - callback: function
 
 (...args: any[]): any
 
 Parameters
 
 Rest ...args: any[]
 
 Returns any
 Returns any
- selector: function
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
 - - (...args: any[]): R
 - Parameters
 - Rest ...args: any[]
 Returns R
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:28
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- T3
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, v3: T3, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - callback: function
 
 (...args: any[]): any
 
 Parameters
 
 Rest ...args: any[]
 
 Returns any
 Returns any
- selector: function
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
 - - (...args: any[]): R
 - Parameters
 - Rest ...args: any[]
 Returns R
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2, v3: T3): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:29
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- T3
- T4
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, v3: T3, v4: T4, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - callback: function
 
 (...args: any[]): any
 
 Parameters
 
 Rest ...args: any[]
 
 Returns any
 Returns any
- selector: function
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
 - - (...args: any[]): R
 - Parameters
 - Rest ...args: any[]
 Returns R
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2, v3: T3, v4: T4): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:30
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- T3
- T4
- T5
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - callback: function
 
 (...args: any[]): any
 
 Parameters
 
 Rest ...args: any[]
 
 Returns any
 Returns any
- selector: function
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
 - - (...args: any[]): R
 - Parameters
 - Rest ...args: any[]
 Returns R
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:31
Converts a callback function to an observable sequence.

Type parameters
- T
- T2
- T3
- T4
- T5
- T6
- R
Parameters
- callbackFunc: function
 
 Function with a callback as the last parameter.
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 - callback: function
 
 (...args: any[]): any
 
 Parameters
 
 Rest ...args: any[]
 
 Returns any
 Returns any
- selector: function
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
 - - (...args: any[]): R
 - Parameters
 - Rest ...args: any[]
 Returns R
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:32
Converts a callback function to an observable sequence.

Type parameters
- T
Parameters
- callbackFunc: Function
 
 Function with a callback as the last parameter.
- Optional selector: void
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (...args: any[]): Observable<T>
 - Parameters
 - Rest ...args: any[]
 Returns Observable<T>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:33
Converts a callback function to an observable sequence.

Type parameters
- T
Parameters
- callbackFunc: Function
 
 Function with a callback as the last parameter.
- Optional selector: function
 
 A selector which takes the arguments from the callback to produce a single item to yield on next.
 - - (...args: any[]): T
 - Parameters
 - Rest ...args: any[]
 Returns T
- Optional scheduler: Scheduler
Returns function

a function which returns the Observable that corresponds to the callback.
- - (...args: any[]): Observable<T>
 - Parameters
 - Rest ...args: any[]
 Returns Observable<T>

DispatchErrorArg

DispatchErrorArg:

err

err: any

subject

subject: AsyncSubject<T>

DispatchNextArg

DispatchNextArg:

subject

subject: AsyncSubject<T>

value

value: T

dispatch

dispatch<T>(state: object): void

- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:105
Type parameters
- T
Parameters
- state: object
 - source: BoundCallbackObservable<T>
 - subscriber: Subscriber<T>
Returns void

dispatchError

dispatchError<T>(arg: DispatchErrorArg<T>): void

- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:155
Type parameters
- T
Parameters
- arg: DispatchErrorArg<T>
Returns void

dispatchNext

dispatchNext<T>(arg: DispatchNextArg<T>): void

- Defined in node_modules/rxjs/src/observable/BoundCallbackObservable.ts:145
Type parameters
- T
Parameters
- arg: DispatchNextArg<T>
Returns void

"node_modules/rxjs/src/observable/BoundNodeCallbackObservable"

"node_modules/rxjs/src/observable/BoundNodeCallbackObservable":

BoundNodeCallbackObservable

BoundNodeCallbackObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new BoundNodeCallbackObservable(callbackFunc: Function, selector: Function, args: any[], scheduler: Scheduler): BoundNodeCallbackObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:45
Parameters
- callbackFunc: Function
- selector: Function
- args: any[]
- scheduler: Scheduler
Returns BoundNodeCallbackObservable

_isScalar

_isScalar: boolean

args

args: any[]

callbackFunc

callbackFunc: Function

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

selector

selector: Function

source

source: Observable<any>

subject

subject: AsyncSubject<T>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T | T[]>): Subscription

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:54
Parameters
- subscriber: Subscriber<T | T[]>
Returns Subscription

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, T3, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, T3, T4, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, T3, T4, T5, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T, T2, T3, T4, T5, T6, R>(callbackFunc: function, selector?: void, scheduler?: Scheduler): function
create<T>(callbackFunc: Function, selector?: void, scheduler?: Scheduler): function
create<T>(callbackFunc: Function, selector?: function, scheduler?: Scheduler): function

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:18
Converts a node callback to an Observable.

Type parameters
- R
Parameters
- callbackFunc: function
 - - (callback: function): any
 - Parameters
 - callback: function
 
 (err: any, result: R): any
 
 Parameters
 
 err: any
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
- Optional scheduler: Scheduler
Returns function
- - (): Observable<R>
 - Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:19
Converts a node callback to an Observable.

Type parameters
- T
- R
Parameters
- callbackFunc: function
 - - (v1: T, callback: function): any
 - Parameters
 - v1: T
 - callback: function
 
 (err: any, result: R): any
 
 Parameters
 
 err: any
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
- Optional scheduler: Scheduler
Returns function
- - (v1: T): Observable<R>
 - Parameters
 - v1: T
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:20
Converts a node callback to an Observable.

Type parameters
- T
- T2
- R
Parameters
- callbackFunc: function
 - - (v1: T, v2: T2, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - callback: function
 
 (err: any, result: R): any
 
 Parameters
 
 err: any
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
- Optional scheduler: Scheduler
Returns function
- - (v1: T, v2: T2): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:21
Converts a node callback to an Observable.

Type parameters
- T
- T2
- T3
- R
Parameters
- callbackFunc: function
 - - (v1: T, v2: T2, v3: T3, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - callback: function
 
 (err: any, result: R): any
 
 Parameters
 
 err: any
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
- Optional scheduler: Scheduler
Returns function
- - (v1: T, v2: T2, v3: T3): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:22
Converts a node callback to an Observable.

Type parameters
- T
- T2
- T3
- T4
- R
Parameters
- callbackFunc: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - callback: function
 
 (err: any, result: R): any
 
 Parameters
 
 err: any
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
- Optional scheduler: Scheduler
Returns function
- - (v1: T, v2: T2, v3: T3, v4: T4): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:23
Converts a node callback to an Observable.

Type parameters
- T
- T2
- T3
- T4
- T5
- R
Parameters
- callbackFunc: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - callback: function
 
 (err: any, result: R): any
 
 Parameters
 
 err: any
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
- Optional scheduler: Scheduler
Returns function
- - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:24
Converts a node callback to an Observable.

Type parameters
- T
- T2
- T3
- T4
- T5
- T6
- R
Parameters
- callbackFunc: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6, callback: function): any
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 - callback: function
 
 (err: any, result: R): any
 
 Parameters
 
 err: any
 
 result: R
 
 Returns any
 Returns any
- Optional selector: void
- Optional scheduler: Scheduler
Returns function
- - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): Observable<R>
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 Returns Observable<R>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:25
Converts a node callback to an Observable.

Type parameters
- T
Parameters
- callbackFunc: Function
- Optional selector: void
- Optional scheduler: Scheduler
Returns function
- - (...args: any[]): Observable<T>
 - Parameters
 - Rest ...args: any[]
 Returns Observable<T>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:26
Converts a node callback to an Observable.

Type parameters
- T
Parameters
- callbackFunc: Function
- Optional selector: function
 - - (...args: any[]): T
 - Parameters
 - Rest ...args: any[]
 Returns T
- Optional scheduler: Scheduler
Returns function
- - (...args: any[]): Observable<T>
 - Parameters
 - Rest ...args: any[]
 Returns Observable<T>

DispatchErrorArg

DispatchErrorArg:

err

err: any

subject

subject: AsyncSubject<T>

DispatchNextArg

DispatchNextArg:

subject

subject: AsyncSubject<T>

value

value: T

dispatch

dispatch<T>(state: object): void

- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:98
Type parameters
- T
Parameters
- state: object
 - source: BoundNodeCallbackObservable<T>
 - subscriber: Subscriber<T>
Returns void

dispatchError

dispatchError<T>(arg: DispatchErrorArg<T>): void

- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:152
Type parameters
- T
Parameters
- arg: DispatchErrorArg<T>
Returns void

dispatchNext

dispatchNext<T>(arg: DispatchNextArg<T>): void

- Defined in node_modules/rxjs/src/observable/BoundNodeCallbackObservable.ts:142
Type parameters
- T
Parameters
- arg: DispatchNextArg<T>
Returns void

"node_modules/rxjs/src/observable/ConnectableObservable"

"node_modules/rxjs/src/observable/ConnectableObservable":

ConnectableObservable

ConnectableObservable:

class: ConnectableObservable

constructor

new ConnectableObservable(source: Observable<T>, subjectFactory: function): ConnectableObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:12
Parameters
- source: Observable<T>
- subjectFactory: function
 - - (): Subject<T>
 - Returns Subject<T>
Returns ConnectableObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<T>

subject

subject: Subject<T>

subjectFactory

subjectFactory: function

Type declaration

- (): Subject<T>
- Returns Subject<T>

subscription

subscription: Subscription

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_closeSubscription

_closeSubscription(): void

- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:50
This method is opened for ConnectableSubscription. Not to call from others.

Returns void

_subscribe

_subscribe(subscriber: Subscriber<T>): Subscription

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:19
Parameters
- subscriber: Subscriber<T>
Returns Subscription

connect

connect(): Subscription

- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:31
Returns Subscription

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

getSubject

getSubject(): Subject<T>

- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:23
Returns Subject<T>

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

refCount

refCount(): Observable<T>

- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:42
Returns Observable<T>

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(subscribe?: function): Observable<T>

Inherited from Observable.create
- Defined in node_modules/rxjs/src/Observable.ts:57
Creates a new cold Observable by calling the Observable constructor

Type parameters
- T
Parameters
- Optional subscribe: function
 - - <R>(subscriber: Subscriber<R>): TeardownLogic
 - Type parameters
 - R
 Parameters
 - subscriber: Subscriber<R>
 Returns TeardownLogic
Returns Observable<T>

a new cold observable

ConnectableSubscription

ConnectableSubscription:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ConnectableSubscription(connectable: ConnectableObservable<any>): ConnectableSubscription

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:61
Parameters
- connectable: ConnectableObservable<any>
Returns ConnectableSubscription

connectable

connectable: ConnectableObservable<any>

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

EMPTY

EMPTY: Subscription

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:66
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscription.ts:61
Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

Returns void

RefCountObservable

RefCountObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new RefCountObservable(connectable: ConnectableObservable<T>, refCount?: number): RefCountObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:79
Parameters
- connectable: ConnectableObservable<T>
- Default value refCount: number = 0
Returns RefCountObservable

_isScalar

_isScalar: boolean

connectable

connectable: ConnectableObservable<T>

connection

connection: Subscription

operator

operator: Operator<any, T>

refCount

refCount: number

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): Subscription

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:86
Parameters
- subscriber: Subscriber<T>
Returns Subscription

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(subscribe?: function): Observable<T>

Inherited from Observable.create
- Defined in node_modules/rxjs/src/Observable.ts:57
Creates a new cold Observable by calling the Observable constructor

Type parameters
- T
Parameters
- Optional subscribe: function
 - - <R>(subscriber: Subscriber<R>): TeardownLogic
 - Type parameters
 - R
 Parameters
 - subscriber: Subscriber<R>
 Returns TeardownLogic
Returns Observable<T>

a new cold observable

RefCountSubscriber

RefCountSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new RefCountSubscriber(destination: Subscriber<T>, refCountObservable: RefCountObservable<T>): RefCountSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:103
Parameters
- destination: Subscriber<T>
- refCountObservable: RefCountObservable<T>
Returns RefCountSubscriber

connection

connection: Subscription

destination

destination: Subscriber<T>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

refCountObservable

refCountObservable: RefCountObservable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:121
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:116
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:112
Parameters
- value: T
Returns void

_resetConnectable

_resetConnectable(): void

- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:126
Returns void

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/observable/ConnectableObservable.ts:138
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/DeferObservable"

"node_modules/rxjs/src/observable/DeferObservable":

DeferObservable

DeferObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new DeferObservable(observableFactory: function): DeferObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/DeferObservable.ts:56
Parameters
- observableFactory: function
  - - (): SubscribableOrPromise | void
    - Returns SubscribableOrPromise | void
Returns DeferObservable

_isScalar

_isScalar: boolean

observableFactory

observableFactory: function

Type declaration

- (): SubscribableOrPromise | void
- Returns SubscribableOrPromise | void

operator

operator: Operator<any, T>

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): Subscription

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/DeferObservable.ts:62
Parameters
- subscriber: Subscriber<T>
Returns Subscription

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(observableFactory: function): Observable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/DeferObservable.ts:54
Creates an Observable that, on subscribe, calls an Observable factory to make an Observable for each new Observer.

Creates the Observable lazily, that is, only when it is subscribed.

defer allows you to create the Observable only when the Observer subscribes, and create a fresh Observable for each Observer. It waits until an Observer subscribes to it, and then it generates an Observable, typically with an Observable factory function. It does this afresh for each subscriber, so although each subscriber may think it is subscribing to the same Observable, in fact each subscriber gets its own individual Observable.

example

Subscribe to either an Observable of clicks or an Observable of interval, at random var clicksOrInterval = Rx.Observable.defer(function () { if (Math.random() > 0.5) { return Rx.Observable.fromEvent(document, 'click'); } else { return Rx.Observable.interval(1000); } }); clicksOrInterval.subscribe(x => console.log(x));

see

{@link create}

static

true

name

defer

owner

Observable

Type parameters
- T
Parameters
- observableFactory: function
 
 The Observable factory function to invoke for each Observer that subscribes to the output Observable. May also return a Promise, which will be converted on the fly to an Observable.
 - - (): SubscribableOrPromise | void
 - Returns SubscribableOrPromise | void
Returns Observable<T>

An Observable whose Observers' subscriptions trigger an invocation of the given Observable factory function.

DeferSubscriber

DeferSubscriber:

constructor

new DeferSubscriber(destination: Subscriber<T>, factory: function): DeferSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/observable/DeferObservable.ts:67
Parameters
- destination: Subscriber<T>
- factory: function
 - - (): SubscribableOrPromise | void
 - Returns SubscribableOrPromise | void
Returns DeferSubscriber

destination

destination: PartialObserver

factory

factory: function

Type declaration

- (): SubscribableOrPromise | void
- Returns SubscribableOrPromise | void

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_callFactory

_callFactory(): void

- Defined in node_modules/rxjs/src/observable/DeferObservable.ts:82
Returns void

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:20
Parameters
- innerSub: InnerSubscriber<T, T>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, T>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:10
Parameters
- outerValue: T
- innerValue: T
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, T>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

tryDefer

tryDefer(): void

- Defined in node_modules/rxjs/src/observable/DeferObservable.ts:74
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/EmptyObservable"

"node_modules/rxjs/src/observable/EmptyObservable":

EmptyObservable

EmptyObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new EmptyObservable(scheduler?: Scheduler): EmptyObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/EmptyObservable.ts:61
Parameters
- Optional scheduler: Scheduler
Returns EmptyObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/EmptyObservable.ts:67
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(scheduler?: Scheduler): Observable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/EmptyObservable.ts:54
Creates an Observable that emits no items to the Observer and immediately emits a complete notification.

Just emits 'complete', and nothing else.

This static operator is useful for creating a simple Observable that only emits the complete notification. It can be used for composing with other Observables, such as in a mergeMap.

example

Emit the number 7, then complete. var result = Rx.Observable.empty().startWith(7); result.subscribe(x => console.log(x));

example

Map and flatten only odd numbers to the sequence 'a', 'b', 'c' var interval = Rx.Observable.interval(1000); var result = interval.mergeMap(x => x % 2 === 1 ? Rx.Observable.of('a', 'b', 'c') : Rx.Observable.empty() ); result.subscribe(x => console.log(x));

see

{@link create}

see

never

see

of

see

throw

static

true

name

empty

owner

Observable

Type parameters
- T
Parameters
- Optional scheduler: Scheduler
Returns Observable<T>

An "empty" Observable: emits only the complete notification.

dispatch

dispatch<T>(arg: DispatchArg<T>): void

- Defined in node_modules/rxjs/src/observable/EmptyObservable.ts:58
Type parameters
- T
Parameters
- arg: DispatchArg<T>
Returns void

DispatchArg

DispatchArg:

subscriber

subscriber: Subscriber<T>

"node_modules/rxjs/src/observable/ErrorObservable"

"node_modules/rxjs/src/observable/ErrorObservable":

ErrorObservable

ErrorObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new ErrorObservable(error: any, scheduler?: Scheduler): ErrorObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/ErrorObservable.ts:64
Parameters
- error: any
- Optional scheduler: Scheduler
Returns ErrorObservable

_isScalar

_isScalar: boolean

error

error: any

operator

operator: Operator<any, any>

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: any): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/ErrorObservable.ts:70
Parameters
- subscriber: any
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: any): void
 - Parameters
 - value: any
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<any, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<any, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(error: any, scheduler?: Scheduler): ErrorObservable

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/ErrorObservable.ts:57
Creates an Observable that emits no items to the Observer and immediately emits an error notification.

Just emits 'error', and nothing else.

This static operator is useful for creating a simple Observable that only emits the error notification. It can be used for composing with other Observables, such as in a mergeMap.

example

Emit the number 7, then emit an error. var result = Rx.Observable.throw(new Error('oops!')).startWith(7); result.subscribe(x => console.log(x), e => console.error(e));

example

Map and flattens numbers to the sequence 'a', 'b', 'c', but throw an error for 13 var interval = Rx.Observable.interval(1000); var result = interval.mergeMap(x => x === 13 ? Rx.Observable.throw('Thirteens are bad') : Rx.Observable.of('a', 'b', 'c') ); result.subscribe(x => console.log(x), e => console.error(e));

see

{@link create}

see

empty

see

never

see

of

static

true

name

throw

owner

Observable

Type parameters
- T
Parameters
- error: any
  
  The particular Error to pass to the error notification.
- Optional scheduler: Scheduler
Returns ErrorObservable

An error Observable: emits only the error notification using the given error argument.

dispatch

dispatch(arg: DispatchArg): void

- Defined in node_modules/rxjs/src/observable/ErrorObservable.ts:61
Parameters
- arg: DispatchArg
Returns void

DispatchArg

DispatchArg:

error

error: any

subscriber

subscriber: any

"node_modules/rxjs/src/observable/ForkJoinObservable"

"node_modules/rxjs/src/observable/ForkJoinObservable":

ForkJoinObservable

ForkJoinObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new ForkJoinObservable(sources: Array<SubscribableOrPromise>, resultSelector?: function): ForkJoinObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/ForkJoinObservable.ts:16
Parameters
- sources: Array<SubscribableOrPromise>
- Optional resultSelector: function
 - - (...values: Array<any>): T
 - Parameters
 - Rest ...values: Array<any>
 Returns T
Returns ForkJoinObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

resultSelector

resultSelector: function

Type declaration

- (...values: Array<any>): T
- Parameters
 - Rest ...values: Array<any>
 Returns T

source

source: Observable<any>

sources

sources: Array<SubscribableOrPromise>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<any>): Subscription

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/ForkJoinObservable.ts:54
Parameters
- subscriber: Subscriber<any>
Returns Subscription

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(...sources: Array<SubscribableOrPromise | Array<SubscribableOrPromise> | function>): Observable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/ForkJoinObservable.ts:29
static

true

name

forkJoin

owner

Observable

Type parameters
- T
Parameters
- Rest ...sources: Array<SubscribableOrPromise | Array<SubscribableOrPromise> | function>
Returns Observable<T>

ForkJoinSubscriber

ForkJoinSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ForkJoinSubscriber(destination: Subscriber<T>, sources: Array<SubscribableOrPromise>, resultSelector?: function): ForkJoinSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/observable/ForkJoinObservable.ts:68
Parameters
- destination: Subscriber<T>
- sources: Array<SubscribableOrPromise>
- Optional resultSelector: function
 - - (...values: Array<any>): T
 - Parameters
 - Rest ...values: Array<any>
 Returns T
Returns ForkJoinSubscriber

completed

completed: number

destination

destination: PartialObserver

haveValues

haveValues: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

resultSelector

resultSelector: function

Type declaration

- (...values: Array<any>): T
- Parameters
 - Rest ...values: Array<any>
 Returns T

sources

sources: Array<SubscribableOrPromise>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

total

total: number

values

values: any[]

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, T>): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/observable/ForkJoinObservable.ts:100
Parameters
- innerSub: InnerSubscriber<T, T>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, T>
Returns void

notifyNext

notifyNext(outerValue: any, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/observable/ForkJoinObservable.ts:90
Parameters
- outerValue: any
- innerValue: T
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, T>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/FromEventObservable"

"node_modules/rxjs/src/observable/FromEventObservable":

FromEventObservable

FromEventObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new FromEventObservable(sourceObj: EventTargetLike, eventName: string, selector?: function): FromEventObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/FromEventObservable.ts:55
Parameters
- sourceObj: EventTargetLike
- eventName: string
- Optional selector: function
 - - (...args: Array<any>): T
 - Parameters
 - Rest ...args: Array<any>
 Returns T
Returns FromEventObservable

_isScalar

_isScalar: boolean

eventName

eventName: string

operator

operator: Operator<any, T>

selector

selector: function

Type declaration

- (...args: Array<any>): T
- Parameters
 - Rest ...args: Array<any>
 Returns T

source

source: Observable<any>

sourceObj

sourceObj: EventTargetLike

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): void

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/FromEventObservable.ts:81
Parameters
- subscriber: Subscriber<T>
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(sourceObj: EventTargetLike, eventName: string, selector?: function): Observable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/FromEventObservable.ts:53
static

true

name

fromEvent

owner

Observable

Type parameters
- T
Parameters
- sourceObj: EventTargetLike
- eventName: string
- Optional selector: function
 - - (...args: Array<any>): T
 - Parameters
 - Rest ...args: Array<any>
 Returns T
Returns Observable<T>

setupSubscription

setupSubscription<T>(sourceObj: EventTargetLike, eventName: string, handler: Function, subscriber: Subscriber<T>): void

- Defined in node_modules/rxjs/src/observable/FromEventObservable.ts:61
Type parameters
- T
Parameters
- sourceObj: EventTargetLike
- eventName: string
- handler: Function
- subscriber: Subscriber<T>
Returns void

EventTargetLike

EventTargetLike: EventTarget | NodeStyleEventEmmitter | JQueryStyleEventEmitter | NodeList | HTMLCollection

JQueryStyleEventEmitter

JQueryStyleEventEmitter: object

Type declaration

off: function
- - (eventName: string, handler: Function): void
  - Parameters
    - eventName: string
    - handler: Function
    Returns void
on: function
- - (eventName: string, handler: Function): void
  - Parameters
    - eventName: string
    - handler: Function
    Returns void

NodeStyleEventEmmitter

NodeStyleEventEmmitter: object

Type declaration

addListener: function
- - (eventName: string, handler: Function): void
  - Parameters
    - eventName: string
    - handler: Function
    Returns void
removeListener: function
- - (eventName: string, handler: Function): void
  - Parameters
    - eventName: string
    - handler: Function
    Returns void

isEventTarget

isEventTarget(sourceObj: any): boolean

- Defined in node_modules/rxjs/src/observable/FromEventObservable.ts:31
Parameters
- sourceObj: any
Returns boolean

isHTMLCollection

isHTMLCollection(sourceObj: any): boolean

- Defined in node_modules/rxjs/src/observable/FromEventObservable.ts:27
Parameters
- sourceObj: any
Returns boolean

isJQueryStyleEventEmitter

isJQueryStyleEventEmitter(sourceObj: any): boolean

- Defined in node_modules/rxjs/src/observable/FromEventObservable.ts:19
Parameters
- sourceObj: any
Returns boolean

isNodeList

isNodeList(sourceObj: any): boolean

- Defined in node_modules/rxjs/src/observable/FromEventObservable.ts:23
Parameters
- sourceObj: any
Returns boolean

isNodeStyleEventEmmitter

isNodeStyleEventEmmitter(sourceObj: any): boolean

- Defined in node_modules/rxjs/src/observable/FromEventObservable.ts:11
Parameters
- sourceObj: any
Returns boolean

"node_modules/rxjs/src/observable/FromEventPatternObservable"

"node_modules/rxjs/src/observable/FromEventPatternObservable":

FromEventPatternObservable

FromEventPatternObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new FromEventPatternObservable(addHandler: function, removeHandler: function, selector?: function): FromEventPatternObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/FromEventPatternObservable.ts:27
Parameters
- addHandler: function
 - - (handler: Function): any
 - Parameters
 - handler: Function
 Returns any
- removeHandler: function
 - - (handler: Function): void
 - Parameters
 - handler: Function
 Returns void
- Optional selector: function
 - - (...args: Array<any>): T
 - Parameters
 - Rest ...args: Array<any>
 Returns T
Returns FromEventPatternObservable

_isScalar

_isScalar: boolean

addHandler

addHandler: function

Type declaration

- (handler: Function): any
- Parameters
  - handler: Function
  Returns any

operator

operator: Operator<any, T>

removeHandler

removeHandler: function

Type declaration

- (handler: Function): void
- Parameters
  - handler: Function
  Returns void

selector

selector: function

Type declaration

- (...args: Array<any>): T
- Parameters
 - Rest ...args: Array<any>
 Returns T

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): void

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/FromEventPatternObservable.ts:35
Parameters
- subscriber: Subscriber<T>
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(addHandler: function, removeHandler: function, selector?: function): FromEventPatternObservable<T, Object>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/FromEventPatternObservable.ts:23
static

true

name

fromEventPattern

owner

Observable

Type parameters
- T
Parameters
- addHandler: function
 - - (handler: Function): any
 - Parameters
 - handler: Function
 Returns any
- removeHandler: function
 - - (handler: Function): void
 - Parameters
 - handler: Function
 Returns void
- Optional selector: function
 - - (...args: Array<any>): T
 - Parameters
 - Rest ...args: Array<any>
 Returns T
Returns FromEventPatternObservable<T, Object>

"node_modules/rxjs/src/observable/FromObservable"

"node_modules/rxjs/src/observable/FromObservable":

FromObservable

FromObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new FromObservable(ish: ObservableInput, scheduler: Scheduler): FromObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/FromObservable.ts:24
Parameters
- ish: ObservableInput
- scheduler: Scheduler
Returns FromObservable

_isScalar

_isScalar: boolean

ish

ish: ObservableInput

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): any

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/FromObservable.ts:74
Parameters
- subscriber: Subscriber<T>
Returns any

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(ish: ObservableInput, scheduler?: Scheduler): Observable<T>
create<T, R>(ish: ArrayLike<T>, mapFn: function, thisArg?: any, scheduler?: Scheduler): Observable<R>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/FromObservable.ts:39
static

true

name

from

owner

Observable

Type parameters
- T
Parameters
- ish: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T>
Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/FromObservable.ts:40
Type parameters
- T
- R
Parameters
- ish: ArrayLike<T>
- mapFn: function
 - - (x: any, y: number): R
 - Parameters
 - x: any
 - y: number
 Returns R
- Optional thisArg: any
- Optional scheduler: Scheduler
Returns Observable<R>

isArrayLike

isArrayLike: (Anonymous function)

"node_modules/rxjs/src/observable/IfObservable"

"node_modules/rxjs/src/observable/IfObservable":

IfObservable

IfObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new IfObservable(condition: function, thenSource?: SubscribableOrPromise | void, elseSource?: SubscribableOrPromise | void): IfObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/IfObservable.ts:18
Parameters
- condition: function
  - - (): boolean | void
    - Returns boolean | void
- Optional thenSource: SubscribableOrPromise | void
- Optional elseSource: SubscribableOrPromise | void
Returns IfObservable

_isScalar

_isScalar: boolean

condition

condition: function

Type declaration

- (): boolean | void
- Returns boolean | void

elseSource

elseSource: SubscribableOrPromise | void

operator

operator: Operator<any, T>

source

source: Observable<any>

thenSource

thenSource: SubscribableOrPromise | void

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T | R>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/IfObservable.ts:26
Parameters
- subscriber: Subscriber<T | R>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T, R>(condition: function, thenSource?: SubscribableOrPromise | void, elseSource?: SubscribableOrPromise | void): Observable<T | R>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/IfObservable.ts:14
Type parameters
- T
- R
Parameters
- condition: function
 - - (): boolean | void
 - Returns boolean | void
- Optional thenSource: SubscribableOrPromise | void
- Optional elseSource: SubscribableOrPromise | void
Returns Observable<T | R>

IfSubscriber

IfSubscriber:

constructor

new IfSubscriber(destination: Subscriber<T>, condition: function, thenSource?: SubscribableOrPromise | void, elseSource?: SubscribableOrPromise | void): IfSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/observable/IfObservable.ts:33
Parameters
- destination: Subscriber<T>
- condition: function
 - - (): boolean | void
 - Returns boolean | void
- Optional thenSource: SubscribableOrPromise | void
- Optional elseSource: SubscribableOrPromise | void
Returns IfSubscriber

condition

condition: function

Type declaration

- (): boolean | void
- Returns boolean | void

destination

destination: PartialObserver

elseSource

elseSource: SubscribableOrPromise | void

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thenSource

thenSource: SubscribableOrPromise | void

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:20
Parameters
- innerSub: InnerSubscriber<T, T>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, T>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:10
Parameters
- outerValue: T
- innerValue: T
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, T>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

tryIf

tryIf(): void

- Defined in node_modules/rxjs/src/observable/IfObservable.ts:42
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/IntervalObservable"

"node_modules/rxjs/src/observable/IntervalObservable":

IntervalObservable

IntervalObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new IntervalObservable(period?: number, scheduler?: Scheduler): IntervalObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/IntervalObservable.ts:63
Parameters
- Default value period: number = 0
- Default value scheduler: Scheduler = async
Returns IntervalObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, number>

period

period: number

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<number>): void

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/IntervalObservable.ts:76
Parameters
- subscriber: Subscriber<number>
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: number): void
 - Parameters
 - value: number
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<number, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<number, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create(period?: number, scheduler?: Scheduler): Observable<number>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/IntervalObservable.ts:46
Creates an Observable that emits sequential numbers every specified interval of time, on a specified Scheduler.

Emits incremental numbers periodically in time.

interval returns an Observable that emits an infinite sequence of ascending integers, with a constant interval of time of your choosing between those emissions. The first emission is not sent immediately, but only after the first period has passed. By default, this operator uses the async Scheduler to provide a notion of time, but you may pass any Scheduler to it.

example

Emits ascending numbers, one every second (1000ms) var numbers = Rx.Observable.interval(1000); numbers.subscribe(x => console.log(x));

see

timer

see

delay

static

true

name

interval

owner

Observable

Parameters
- Default value period: number = 0
- Default value scheduler: Scheduler = async
Returns Observable<number>

An Observable that emits a sequential number each time interval.

dispatch

dispatch(state: any): void

- Defined in node_modules/rxjs/src/observable/IntervalObservable.ts:51
Parameters
- state: any
Returns void

"node_modules/rxjs/src/observable/IteratorObservable"

"node_modules/rxjs/src/observable/IteratorObservable":

ArrayIterator

ArrayIterator:

constructor

new ArrayIterator(arr: Array<any>, idx?: number, len?: number): ArrayIterator

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:142
Parameters
- arr: Array<any>
- Default value idx: number = 0
- Default value len: number = toLength(arr)
Returns ArrayIterator

arr

arr: Array<any>

idx

idx: number

len

len: number

__computed

__computed(): ArrayIterator

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:147
Returns ArrayIterator

next(): object

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:148
Returns object
- done: boolean
- value: any

IteratorObservable

IteratorObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new IteratorObservable(iterator: any, project?: function | any, thisArg?: any | Scheduler, scheduler?: Scheduler): IteratorObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:66
Parameters
- iterator: any
- Optional project: function | any
- Optional thisArg: any | Scheduler
- Optional scheduler: Scheduler
Returns IteratorObservable

_isScalar

_isScalar: boolean

iterator

iterator: any

operator

operator: Operator<any, T>

project

project: function

Type declaration

- (x?: any, i?: number): T
- Parameters
  - Optional x: any
  - Optional i: number
  Returns T

scheduler

scheduler: Scheduler

source

source: Observable<any>

thisArg

thisArg: any

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:92
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(iterator: any, project?: function | any, thisArg?: any | Scheduler, scheduler?: Scheduler): IteratorObservable<Object>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:20
Type parameters
- T
Parameters
- iterator: any
- Optional project: function | any
- Optional thisArg: any | Scheduler
- Optional scheduler: Scheduler
Returns IteratorObservable<Object>

dispatch

dispatch(state: any): void

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:27
Parameters
- state: any
Returns void

StringIterator

StringIterator:

constructor

new StringIterator(str: string, idx?: number, len?: number): StringIterator

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:125
Parameters
- str: string
- Default value idx: number = 0
- Default value len: number = str.length
Returns StringIterator

idx

idx: number

len

len: number

str

str: string

__computed

__computed(): StringIterator

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:130
Returns StringIterator

next(): object

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:131
Returns object
- done: boolean
- value: string

maxSafeInteger

maxSafeInteger: number

getIterator

getIterator(obj: any): any

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:159
Parameters
- obj: any
Returns any

numberIsFinite

numberIsFinite(value: any): any

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:193
Parameters
- value: any
Returns any

sign

sign(value: any): number

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:197
Parameters
- value: any
Returns number

toLength

toLength(o: any): number

- Defined in node_modules/rxjs/src/observable/IteratorObservable.ts:175
Parameters
- o: any
Returns number

"node_modules/rxjs/src/observable/NeverObservable"

"node_modules/rxjs/src/observable/NeverObservable":

NeverObservable

NeverObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new NeverObservable(): NeverObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/NeverObservable.ts:44
Returns NeverObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): void

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/NeverObservable.ts:50
Parameters
- subscriber: Subscriber<T>
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(): NeverObservable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/NeverObservable.ts:42
Creates an Observable that emits no items to the Observer.

An Observable that never emits anything.

This static operator is useful for creating a simple Observable that emits neither values nor errors nor the completion notification. It can be used for testing purposes or for composing with other Observables. Please not that by never emitting a complete notification, this Observable keeps the subscription from being disposed automatically. Subscriptions need to be manually disposed.

example

Emit the number 7, then never emit anything else (not even complete). function info() { console.log('Will not be called'); } var result = Rx.Observable.never().startWith(7); result.subscribe(x => console.log(x), info, info);

see

{@link create}

see

empty

see

of

see

throw

static

true

name

never

owner

Observable

Type parameters
- T
Returns NeverObservable<T>

A "never" Observable: never emits anything.

"node_modules/rxjs/src/observable/PromiseObservable"

"node_modules/rxjs/src/observable/PromiseObservable":

PromiseObservable

PromiseObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new PromiseObservable(promise: Promise<T>, scheduler?: Scheduler): PromiseObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/PromiseObservable.ts:26
Parameters
- promise: Promise<T>
- Default value scheduler: Scheduler = null
Returns PromiseObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

promise

promise: Promise<T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

value

value: T

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/PromiseObservable.ts:32
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(promise: Promise<T>, scheduler?: Scheduler): Observable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/PromiseObservable.ts:24
static

true

name

fromPromise

owner

Observable

Type parameters
- T
Parameters
- promise: Promise<T>
- Default value scheduler: Scheduler = null
Returns Observable<T>

DispatchErrorArg

DispatchErrorArg:

err

err: any

subscriber

subscriber: Subscriber<T>

DispatchNextArg

DispatchNextArg:

subscriber

subscriber: Subscriber<T>

value

value: T

dispatchError

dispatchError<T>(arg: DispatchErrorArg<T>): void

- Defined in node_modules/rxjs/src/observable/PromiseObservable.ts:107
Type parameters
- T
Parameters
- arg: DispatchErrorArg<T>
Returns void

dispatchNext

dispatchNext<T>(arg: DispatchNextArg<T>): void

- Defined in node_modules/rxjs/src/observable/PromiseObservable.ts:95
Type parameters
- T
Parameters
- arg: DispatchNextArg<T>
Returns void

"node_modules/rxjs/src/observable/RangeObservable"

"node_modules/rxjs/src/observable/RangeObservable":

RangeObservable

RangeObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new RangeObservable(start: number, count: number, scheduler?: Scheduler): RangeObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/RangeObservable.ts:72
Parameters
- start: number
- count: number
- Optional scheduler: Scheduler
Returns RangeObservable

_count

_count: number

_isScalar

_isScalar: boolean

operator

operator: Operator<any, number>

scheduler

scheduler: Scheduler

source

source: Observable<any>

start

start: number

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<number>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/RangeObservable.ts:83
Parameters
- subscriber: Subscriber<number>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: number): void
 - Parameters
 - value: number
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<number, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<number, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create(start?: number, count?: number, scheduler?: Scheduler): Observable<number>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/RangeObservable.ts:43
Creates an Observable that emits a sequence of numbers within a specified range.

Emits a sequence of numbers in a range.

range operator emits a range of sequential integers, in order, where you select the start of the range and its length. By default, uses no Scheduler and just delivers the notifications synchronously, but may use an optional Scheduler to regulate those deliveries.

example

Emits the numbers 1 to 10 var numbers = Rx.Observable.range(1, 10); numbers.subscribe(x => console.log(x));

see

timer

see

interval

static

true

name

range

owner

Observable

Parameters
- Default value start: number = 0
- Default value count: number = 0
- Optional scheduler: Scheduler
Returns Observable<number>

An Observable of numbers that emits a finite range of sequential integers.

dispatch

dispatch(state: any): void

- Defined in node_modules/rxjs/src/observable/RangeObservable.ts:49
Parameters
- state: any
Returns void

"node_modules/rxjs/src/observable/ScalarObservable"

"node_modules/rxjs/src/observable/ScalarObservable":

ScalarObservable

ScalarObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new ScalarObservable(value: T, scheduler?: Scheduler): ScalarObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/ScalarObservable.ts:33
Parameters
- value: T
- Optional scheduler: Scheduler
Returns ScalarObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

value

value: T

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/ScalarObservable.ts:39
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(value: T, scheduler?: Scheduler): ScalarObservable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/ScalarObservable.ts:12
Type parameters
- T
Parameters
- value: T
- Optional scheduler: Scheduler
Returns ScalarObservable<T>

dispatch

dispatch(state: any): void

- Defined in node_modules/rxjs/src/observable/ScalarObservable.ts:16
Parameters
- state: any
Returns void

"node_modules/rxjs/src/observable/SubscribeOnObservable"

"node_modules/rxjs/src/observable/SubscribeOnObservable":

SubscribeOnObservable

SubscribeOnObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new SubscribeOnObservable(source: Observable<T>, delayTime?: number, scheduler?: Scheduler): SubscribeOnObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/SubscribeOnObservable.ts:26
Parameters
- source: Observable<T>
- Default value delayTime: number = 0
- Default value scheduler: Scheduler = asap
Returns SubscribeOnObservable

_isScalar

_isScalar: boolean

delayTime

delayTime: number

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<T>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): Subscription

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/SubscribeOnObservable.ts:40
Parameters
- subscriber: Subscriber<T>
Returns Subscription

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(source: Observable<T>, delay?: number, scheduler?: Scheduler): Observable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/SubscribeOnObservable.ts:19
Type parameters
- T
Parameters
- source: Observable<T>
- Default value delay: number = 0
- Default value scheduler: Scheduler = asap
Returns Observable<T>

dispatch

dispatch<T>(arg: DispatchArg<T>): Subscription

- Defined in node_modules/rxjs/src/observable/SubscribeOnObservable.ts:23
Type parameters
- T
Parameters
- arg: DispatchArg<T>
Returns Subscription

DispatchArg

DispatchArg:

source

source: Observable<T>

subscriber

subscriber: Subscriber<T>

"node_modules/rxjs/src/observable/TimerObservable"

"node_modules/rxjs/src/observable/TimerObservable":

TimerObservable

TimerObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new TimerObservable(dueTime?: number | Date, period?: number | Scheduler, scheduler?: Scheduler): TimerObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/TimerObservable.ts:84
Parameters
- Default value dueTime: number | Date = 0
- Optional period: number | Scheduler
- Optional scheduler: Scheduler
Returns TimerObservable

_isScalar

_isScalar: boolean

dueTime

dueTime: number

operator

operator: Operator<any, number>

period

period: number

scheduler

scheduler: Scheduler

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<number>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/TimerObservable.ts:107
Parameters
- subscriber: Subscriber<number>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: number): void
 - Parameters
 - value: number
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<number, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<number, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create(initialDelay?: number | Date, period?: number | Scheduler, scheduler?: Scheduler): Observable<number>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/TimerObservable.ts:59
Creates an Observable that starts emitting after an initialDelay and emits ever increasing numbers after each period of time thereafter.

Its like interval, but you can specify when should the emissions start.

timer returns an Observable that emits an infinite sequence of ascending integers, with a constant interval of time, period of your choosing between those emissions. The first emission happens after the specified initialDelay. The initial delay may be a {@link Date}. By default, this operator uses the async Scheduler to provide a notion of time, but you may pass any Scheduler to it. If period is not specified, the output Observable emits only one value, 0. Otherwise, it emits an infinite sequence.

example

Emits ascending numbers, one every second (1000ms), starting after 3 seconds var numbers = Rx.Observable.timer(3000, 1000); numbers.subscribe(x => console.log(x));

example

Emits one number after five seconds var numbers = Rx.Observable.timer(5000); numbers.subscribe(x => console.log(x));

see

interval

see

delay

static

true

name

timer

owner

Observable

Parameters
- Default value initialDelay: number | Date = 0
 
 The initial delay time to wait before emitting the first value of 0.
- Optional period: number | Scheduler
- Optional scheduler: Scheduler
Returns Observable<number>

An Observable that emits a 0 after the initialDelay and ever increasing numbers after each period of time thereafter.

dispatch

dispatch(state: any): any

- Defined in node_modules/rxjs/src/observable/TimerObservable.ts:65
Parameters
- state: any
Returns any

"node_modules/rxjs/src/observable/UsingObservable"

"node_modules/rxjs/src/observable/UsingObservable":

UsingObservable

UsingObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new UsingObservable(resourceFactory: function, observableFactory: function): UsingObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/UsingObservable.ts:17
Parameters
- resourceFactory: function
  - - (): AnonymousSubscription | void
    - Returns AnonymousSubscription | void
- observableFactory: function
  - - (resource: AnonymousSubscription): SubscribableOrPromise | void
    - Parameters
      - resource: AnonymousSubscription
      Returns SubscribableOrPromise | void
Returns UsingObservable

_isScalar

_isScalar: boolean

observableFactory

observableFactory: function

Type declaration

- (resource: AnonymousSubscription): SubscribableOrPromise | void
- Parameters
  - resource: AnonymousSubscription
  Returns SubscribableOrPromise | void

operator

operator: Operator<any, T>

resourceFactory

resourceFactory: function

Type declaration

- (): AnonymousSubscription | void
- Returns AnonymousSubscription | void

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/UsingObservable.ts:24
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(resourceFactory: function, observableFactory: function): Observable<T>

Overwrites Observable.create
- Defined in node_modules/rxjs/src/observable/UsingObservable.ts:14
Type parameters
- T
Parameters
- resourceFactory: function
 - - (): AnonymousSubscription | void
 - Returns AnonymousSubscription | void
- observableFactory: function
 - - (resource: AnonymousSubscription): SubscribableOrPromise | void
 - Parameters
 - resource: AnonymousSubscription
 Returns SubscribableOrPromise | void
Returns Observable<T>

UsingSubscriber

UsingSubscriber:

constructor

new UsingSubscriber(destination: Subscriber<T>, resource: AnonymousSubscription, observableFactory: function): UsingSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/observable/UsingObservable.ts:38
Parameters
- destination: Subscriber<T>
- resource: AnonymousSubscription
- observableFactory: function
 - - (resource: AnonymousSubscription): SubscribableOrPromise | void
 - Parameters
 - resource: AnonymousSubscription
 Returns SubscribableOrPromise | void
Returns UsingSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

observableFactory

observableFactory: function

Type declaration

- (resource: AnonymousSubscription): SubscribableOrPromise | void
- Parameters
  - resource: AnonymousSubscription
  Returns SubscribableOrPromise | void

resource

resource: AnonymousSubscription

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:20
Parameters
- innerSub: InnerSubscriber<T, T>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, T>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:10
Parameters
- outerValue: T
- innerValue: T
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, T>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

tryUse

tryUse(): void

- Defined in node_modules/rxjs/src/observable/UsingObservable.ts:47
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

"node_modules/rxjs/src/observable/bindCallback"

"node_modules/rxjs/src/observable/bindCallback":

bindCallback

bindCallback: create

"node_modules/rxjs/src/observable/bindNodeCallback"

"node_modules/rxjs/src/observable/bindNodeCallback":

bindNodeCallback

bindNodeCallback: create

"node_modules/rxjs/src/observable/concat"

"node_modules/rxjs/src/observable/concat":

concat

concat: concatStatic

"node_modules/rxjs/src/observable/defer"

"node_modules/rxjs/src/observable/defer":

defer

defer: create

"node_modules/rxjs/src/observable/dom/AjaxObservable"

"node_modules/rxjs/src/observable/dom/AjaxObservable":

AjaxError

AjaxError:

A normalized AJAX error.

see: ajax
class: AjaxError

constructor

new AjaxError(message: string, xhr: XMLHttpRequest, request: AjaxRequest): AjaxError

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:415
Parameters
- message: string
- xhr: XMLHttpRequest
- request: AjaxRequest
Returns AjaxError

request

request: AjaxRequest

type: {AjaxRequest} The AjaxRequest associated with the error

status

status: number

type: {number} The HTTP status code

xhr

xhr: XMLHttpRequest

type: {XMLHttpRequest} The XHR instance associated with the error

Error

Error: ErrorConstructor

message

message: string

name

stack

stack: string

AjaxObservable

AjaxObservable:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new AjaxObservable(urlOrRequest: string | AjaxRequest): AjaxObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:123
Parameters
- urlOrRequest: string | AjaxRequest
Returns AjaxObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

request

request: AjaxRequest

source

source: Observable<any>

create

create: AjaxCreationMethod

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): TeardownLogic

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:151
Parameters
- subscriber: Subscriber<T>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

_create_stub

_create_stub(): void

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:107
Creates an observable for an Ajax request with either a request object with url, headers, etc or a string for a URL.

example

source = Rx.Observable.ajax('/products'); source = Rx.Observable.ajax( url: 'products', method: 'GET' });

static

true

name

ajax

owner

Observable

Returns void

An observable sequence containing the XMLHttpRequest.

AjaxResponse

AjaxResponse:

A normalized AJAX response.

see: ajax
class: AjaxResponse

constructor

new AjaxResponse(originalEvent: Event, xhr: XMLHttpRequest, request: AjaxRequest): AjaxResponse

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:374
Parameters
- originalEvent: Event
- xhr: XMLHttpRequest
- request: AjaxRequest
Returns AjaxResponse

originalEvent

originalEvent: Event

request

request: AjaxRequest

response

response: any

type: {string|ArrayBuffer|Document|object|any} The response data

responseText

responseText: string

type: {string} The raw responseText

responseType

responseType: string

type: {string} The responseType (e.g. 'json', 'arraybuffer', or 'xml')

status

status: number

type: {number} The HTTP status code

xhr

xhr: XMLHttpRequest

AjaxSubscriber

AjaxSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new AjaxSubscriber(destination: Subscriber<T>, request: AjaxRequest): AjaxSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:164
Parameters
- destination: Subscriber<T>
- request: AjaxRequest
Returns AjaxSubscriber

destination

destination: PartialObserver

done

done: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

request

request: AjaxRequest

resultSelector

resultSelector: function

Type declaration

- (response: AjaxResponse): T
- Parameters
  - response: AjaxResponse
  Returns T

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

xhr

xhr: XMLHttpRequest

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: Event): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: Event
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(e: Event): void

Overwrites Subscriber.next
- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:188
Parameters
- e: Event
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

send

send(): XMLHttpRequest

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:205
Returns XMLHttpRequest

serializeBody

serializeBody(body: any, contentType: string): any

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:250
Parameters
- body: any
- contentType: string
Returns any

setHeaders

setHeaders(xhr: XMLHttpRequest, headers: Object): void

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:270
Parameters
- xhr: XMLHttpRequest
- headers: Object
Returns void

setupEvents

setupEvents(xhr: XMLHttpRequest, request: AjaxRequest): void

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:278
Parameters
- xhr: XMLHttpRequest
- request: AjaxRequest
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Overwrites Subscriber.unsubscribe
- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:347
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

AjaxTimeoutError

AjaxTimeoutError:

see: ajax
class: AjaxTimeoutError

constructor

new AjaxTimeoutError(xhr: XMLHttpRequest, request: AjaxRequest): AjaxTimeoutError

Overwrites AjaxError.constructor
- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:431
Parameters
- xhr: XMLHttpRequest
- request: AjaxRequest
Returns AjaxTimeoutError

request

request: AjaxRequest

type: {AjaxRequest} The AjaxRequest associated with the error

status

status: number

type: {number} The HTTP status code

xhr

xhr: XMLHttpRequest

type: {XMLHttpRequest} The XHR instance associated with the error

message

message: string

name

stack

stack: string

AjaxCreationMethod

__call<T>(urlOrRequest: string | AjaxRequest): Observable<T>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:41
Type parameters
- T
Parameters
- urlOrRequest: string | AjaxRequest
Returns Observable<T>

delete

delete<T>(url: string, headers?: Object): Observable<T>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:46
Type parameters
- T
Parameters
- url: string
- Optional headers: Object
Returns Observable<T>

get

get<T>(url: string, resultSelector?: function, headers?: Object): Observable<T>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:43
Type parameters
- T
Parameters
- url: string
- Optional resultSelector: function
 - - (response: AjaxResponse): T
 - Parameters
 - response: AjaxResponse
 Returns T
- Optional headers: Object
Returns Observable<T>

getJSON

getJSON<T, R>(url: string, resultSelector?: function, headers?: Object): Observable<R>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:47
Type parameters
- T
- R
Parameters
- url: string
- Optional resultSelector: function
 - - (data: T): R
 - Parameters
 - data: T
 Returns R
- Optional headers: Object
Returns Observable<R>

post

post<T>(url: string, body?: any, headers?: Object): Observable<T>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:44
Type parameters
- T
Parameters
- url: string
- Optional body: any
- Optional headers: Object
Returns Observable<T>

put

put<T>(url: string, body?: any, headers?: Object): Observable<T>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:45
Type parameters
- T
Parameters
- url: string
- Optional body: any
- Optional headers: Object
Returns Observable<T>

AjaxRequest

AjaxRequest:

async

async: boolean

body

body: any

createXHR

createXHR: function

Type declaration

- (): XMLHttpRequest
- Returns XMLHttpRequest

crossDomain

crossDomain: boolean

hasContent

hasContent: boolean

headers

headers: Object

method

method: string

password

password: string

progressSubscriber

progressSubscriber: Subscriber<any>

responseType

responseType: string

resultSelector

resultSelector: function

Type declaration

- <T>(response: AjaxResponse): T
- Type parameters
 - T
 Parameters
 - response: AjaxResponse
 Returns T

timeout

timeout: number

url

url: string

user

user: string

ajaxDelete

ajaxDelete<T>(url: string, headers?: Object): Observable<T>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:62
Type parameters
- T
Parameters
- url: string
- Optional headers: Object
Returns Observable<T>

ajaxGet

ajaxGet<T>(url: string, resultSelector?: function, headers?: Object): AjaxObservable<T>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:54
Type parameters
- T
Parameters
- url: string
- Default value resultSelector: function = defaultGetResultSelector
 - - (response: AjaxResponse): T
 - Parameters
 - response: AjaxResponse
 Returns T
- Default value headers: Object = null
Returns AjaxObservable<T>

ajaxGetJSON

ajaxGetJSON<T, R>(url: string, resultSelector?: function, headers?: Object): Observable<R>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:70
Type parameters
- T
- R
Parameters
- url: string
- Optional resultSelector: function
 - - (data: T): R
 - Parameters
 - data: T
 Returns R
- Optional headers: Object
Returns Observable<R>

ajaxPost

ajaxPost<T>(url: string, body?: any, headers?: Object): Observable<T>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:58
Type parameters
- T
Parameters
- url: string
- Optional body: any
- Optional headers: Object
Returns Observable<T>

ajaxPut

ajaxPut<T>(url: string, body?: any, headers?: Object): Observable<T>

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:66
Type parameters
- T
Parameters
- url: string
- Optional body: any
- Optional headers: Object
Returns Observable<T>

createXHRDefault

createXHRDefault(): XMLHttpRequest

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:25
Returns XMLHttpRequest

defaultGetResultSelector

defaultGetResultSelector<T>(response: AjaxResponse): T

- Defined in node_modules/rxjs/src/observable/dom/AjaxObservable.ts:50
Type parameters
- T
Parameters
- response: AjaxResponse
Returns T

"node_modules/rxjs/src/observable/dom/MiscJSDoc"

"node_modules/rxjs/src/observable/dom/MiscJSDoc":

AjaxRequestDoc

AjaxRequestDoc:

see: ajax
interface
name: AjaxRequest
noimport: true

async

async: boolean

type: {boolean}

body

body: any

type: {number}

crossDomain

crossDomain: boolean

type: {boolean}

hasContent

hasContent: boolean

type: {boolean}

headers

headers: Object

type: {Object}

method

method: string

type: {string}

password

password: string

type: {string}

progressSubscriber

progressSubscriber: Subscriber<any>

type: {Subscriber}

responseType

responseType: string

type: {string}

timeout

timeout: number

type: {number}

url

url: string

type: {string}

user

user: string

type: {string}

createXHR

createXHR(): XMLHttpRequest

- Defined in node_modules/rxjs/src/observable/dom/MiscJSDoc.ts:55
Returns XMLHttpRequest

resultSelector

resultSelector<T>(response: AjaxResponse): T

- Defined in node_modules/rxjs/src/observable/dom/MiscJSDoc.ts:66
Type parameters
- T
Parameters
- response: AjaxResponse
Returns T

"node_modules/rxjs/src/observable/dom/WebSocketSubject"

"node_modules/rxjs/src/observable/dom/WebSocketSubject":

WebSocketSubject

WebSocketSubject:

We need this JSDoc comment for affecting ESDoc.

extends: {Ignored}
hide: true

constructor

new WebSocketSubject(urlConfigOrSource: string | WebSocketSubjectConfig | Observable<T>, destination?: Observer<T>): WebSocketSubject

Overwrites Subject.constructor
- Defined in node_modules/rxjs/src/observable/dom/WebSocketSubject.ts:50
Parameters
- urlConfigOrSource: string | WebSocketSubjectConfig | Observable<T>
- Optional destination: Observer<T>
Returns WebSocketSubject

WebSocketCtor

WebSocketCtor: object

Type declaration

constructor: function
- new __type(url: string, protocol?: string | Array<string>): __type
- - Defined in node_modules/rxjs/src/observable/dom/WebSocketSubject.ts:35
 Parameters
 - url: string
 - Optional protocol: string | Array<string>
 Returns __type

_isScalar

_isScalar: boolean

closeObserver

closeObserver: NextObserver<CloseEvent>

closingObserver

closingObserver: NextObserver<void>

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

observers

observers: Observer<T>[]

openObserver

openObserver: NextObserver<Event>

operator

operator: Operator<any, T>

protocol

protocol: string | Array<string>

socket

socket: WebSocket

source

source: Observable<T>

url

url: string

if

if: create

throw

throw: create

__computed

__computed(): Subscriber<T>

Inherited from Subject.__computed

Overwrites Observable.__computed
- Defined in node_modules/rxjs/src/Subject.ts:222
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subject._complete
- Defined in node_modules/rxjs/src/Subject.ts:187
Returns void

_error

_error(err: any): void

Inherited from Subject._error
- Defined in node_modules/rxjs/src/Subject.ts:158
Parameters
- err: any
Returns void

_finalComplete

_finalComplete(): void

Inherited from Subject._finalComplete
- Defined in node_modules/rxjs/src/Subject.ts:195
Returns void

_finalError

_finalError(err: any): void

Inherited from Subject._finalError
- Defined in node_modules/rxjs/src/Subject.ts:166
Parameters
- err: any
Returns void

_finalNext

_finalNext(value: T): void

Inherited from Subject._finalNext
- Defined in node_modules/rxjs/src/Subject.ts:148
Parameters
- value: T
Returns void

_next

_next(value: T): void

Inherited from Subject._next
- Defined in node_modules/rxjs/src/Subject.ts:140
Parameters
- value: T
Returns void

_subscribe

_subscribe(subscriber: Subscriber<T>): Subscription

Overwrites Subject._subscribe
- Defined in node_modules/rxjs/src/observable/dom/WebSocketSubject.ts:125
Parameters
- subscriber: Subscriber<T>
Returns Subscription

_unsubscribe

_unsubscribe(): void

Overwrites Subject._unsubscribe
- Defined in node_modules/rxjs/src/observable/dom/WebSocketSubject.ts:114
Returns void

add

add(subscription: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subject.add
- Defined in node_modules/rxjs/src/Subject.ts:41
Parameters
- subscription: TeardownLogic
Returns Subscription

asObservable

asObservable(): Observable<T>

Inherited from Subject.asObservable
- Defined in node_modules/rxjs/src/Subject.ts:135
Returns Observable<T>

complete

complete(): void

Inherited from Subject.complete
- Defined in node_modules/rxjs/src/Subject.ts:118
Returns void

error

error(err?: any): void

Inherited from Subject.error
- Defined in node_modules/rxjs/src/Subject.ts:100
Parameters
- Optional err: any
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): WebSocketSubject<T>

Overwrites Subject.lift
- Defined in node_modules/rxjs/src/observable/dom/WebSocketSubject.ts:74
Type parameters
- R
Parameters
- operator: Operator<T, R>
Returns WebSocketSubject<T>

multiplex

multiplex(subMsg: function, unsubMsg: function, messageFilter: function): Observable<Object>

- Defined in node_modules/rxjs/src/observable/dom/WebSocketSubject.ts:81
Parameters
- subMsg: function
 - - (): any
 - Returns any
- unsubMsg: function
 - - (): any
 - Returns any
- messageFilter: function
 - - (value: T): boolean
 - Parameters
 - value: T
 Returns boolean
Returns Observable<Object>

next(value: T): void

Inherited from Subject.next
- Defined in node_modules/rxjs/src/Subject.ts:82
Parameters
- value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subject.remove
- Defined in node_modules/rxjs/src/Subject.ts:45
Parameters
- subscription: Subscription
Returns void

resultSelector

resultSelector(e: MessageEvent): any

- Defined in node_modules/rxjs/src/observable/dom/WebSocketSubject.ts:37
Parameters
- e: MessageEvent
Returns any

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subject.unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:49
Returns void

create

create<T>(urlConfigOrSource: string | WebSocketSubjectConfig): WebSocketSubject<T>

Overwrites Subject.create
- Defined in node_modules/rxjs/src/observable/dom/WebSocketSubject.ts:48
static

true

name

webSocket

owner

Observable

Type parameters
- T
Parameters
- urlConfigOrSource: string | WebSocketSubjectConfig
Returns WebSocketSubject<T>

WebSocketSubjectConfig

WebSocketSubjectConfig:

WebSocketCtor

WebSocketCtor: object

Type declaration

constructor: function
- new __type(url: string, protocol?: string | Array<string>): __type
- - Defined in node_modules/rxjs/src/observable/dom/WebSocketSubject.ts:20
 Parameters
 - url: string
 - Optional protocol: string | Array<string>
 Returns __type

closeObserver

closeObserver: NextObserver<CloseEvent>

closingObserver

closingObserver: NextObserver<void>

openObserver

openObserver: NextObserver<Event>

protocol

protocol: string | Array<string>

resultSelector

resultSelector: function

Type declaration

- <T>(e: MessageEvent): T
- Type parameters
 - T
 Parameters
 - e: MessageEvent
 Returns T

url

url: string

"node_modules/rxjs/src/observable/dom/ajax"

"node_modules/rxjs/src/observable/dom/ajax":

ajax

ajax: AjaxCreationMethod

"node_modules/rxjs/src/observable/dom/webSocket"

"node_modules/rxjs/src/observable/dom/webSocket":

webSocket

webSocket: create

"node_modules/rxjs/src/observable/empty"

"node_modules/rxjs/src/observable/empty":

empty

empty: create

"node_modules/rxjs/src/observable/forkJoin"

"node_modules/rxjs/src/observable/forkJoin":

forkJoin

forkJoin: create

"node_modules/rxjs/src/observable/from"

"node_modules/rxjs/src/observable/from":

from

from: create

"node_modules/rxjs/src/observable/fromEvent"

"node_modules/rxjs/src/observable/fromEvent":

fromEvent

fromEvent: create

"node_modules/rxjs/src/observable/fromEventPattern"

"node_modules/rxjs/src/observable/fromEventPattern":

fromEventPattern

fromEventPattern: create

"node_modules/rxjs/src/observable/fromPromise"

"node_modules/rxjs/src/observable/fromPromise":

fromPromise

fromPromise: create

"node_modules/rxjs/src/observable/if"

"node_modules/rxjs/src/observable/if":

_if

_if: create

"node_modules/rxjs/src/observable/interval"

"node_modules/rxjs/src/observable/interval":

interval

interval: create

"node_modules/rxjs/src/observable/merge"

"node_modules/rxjs/src/observable/merge":

merge

merge: mergeStatic

"node_modules/rxjs/src/observable/never"

"node_modules/rxjs/src/observable/never":

never

never: create

"node_modules/rxjs/src/observable/of"

"node_modules/rxjs/src/observable/of":

of

of: of

"node_modules/rxjs/src/observable/range"

"node_modules/rxjs/src/observable/range":

range

range: create

"node_modules/rxjs/src/observable/throw"

"node_modules/rxjs/src/observable/throw":

_throw

_throw: create

"node_modules/rxjs/src/observable/timer"

"node_modules/rxjs/src/observable/timer":

timer

timer: create

"node_modules/rxjs/src/observable/using"

"node_modules/rxjs/src/observable/using":

using

using: create

"node_modules/rxjs/src/observable/zip"

"node_modules/rxjs/src/observable/zip":

zip

zip: zipStatic

"node_modules/rxjs/src/operator/audit"

"node_modules/rxjs/src/operator/audit":

AuditOperator

AuditOperator:

constructor

new AuditOperator(durationSelector: function): AuditOperator

- Defined in node_modules/rxjs/src/operator/audit.ts:25
Parameters
- durationSelector: function
  - - (value: T): SubscribableOrPromise
    - Parameters
      - value: T
      Returns SubscribableOrPromise
Returns AuditOperator

durationSelector

durationSelector: function

Type declaration

- (value: T): SubscribableOrPromise
- Parameters
  - value: T
  Returns SubscribableOrPromise

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/audit.ts:29
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

AuditSubscriber

AuditSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new AuditSubscriber(destination: Subscriber<T>, durationSelector: function): AuditSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/audit.ts:43
Parameters
- destination: Subscriber<T>
- durationSelector: function
 - - (value: T): SubscribableOrPromise
 - Parameters
 - value: T
 Returns SubscribableOrPromise
Returns AuditSubscriber

destination

destination: PartialObserver

durationSelector

durationSelector: function

Type declaration

- (value: T): SubscribableOrPromise
- Parameters
  - value: T
  Returns SubscribableOrPromise

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

throttled

throttled: Subscription

value

value: T

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/audit.ts:50
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

clearThrottle

clearThrottle(): void

- Defined in node_modules/rxjs/src/operator/audit.ts:63
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/audit.ts:81
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/audit.ts:77
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

AuditSignature

__call(durationSelector: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/audit.ts:21
Parameters
- durationSelector: function
 - - (value: T): SubscribableOrPromise
 - Parameters
 - value: T
 Returns SubscribableOrPromise
Returns Observable<T>

audit

audit<T>(durationSelector: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/audit.ts:17
method

audit

owner

Observable

Type parameters
- T
Parameters
- durationSelector: function
 - - (value: T): SubscribableOrPromise
 - Parameters
 - value: T
 Returns SubscribableOrPromise
Returns Observable<T>

"node_modules/rxjs/src/operator/auditTime"

"node_modules/rxjs/src/operator/auditTime":

AuditTimeOperator

AuditTimeOperator:

constructor

new AuditTimeOperator(delay: number, scheduler: Scheduler): AuditTimeOperator

- Defined in node_modules/rxjs/src/operator/auditTime.ts:23
Parameters
- delay: number
- scheduler: Scheduler
Returns AuditTimeOperator

delay

delay: number

scheduler

scheduler: Scheduler

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/auditTime.ts:27
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

AuditTimeSubscriber

AuditTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new AuditTimeSubscriber(destination: Subscriber<T>, delay: number, scheduler: Scheduler): AuditTimeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/auditTime.ts:41
Parameters
- destination: Subscriber<T>
- delay: number
- scheduler: Scheduler
Returns AuditTimeSubscriber

delay

delay: number

destination

destination: PartialObserver

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

throttled

throttled: Subscription

value

value: T

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/auditTime.ts:49
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

clearThrottle

clearThrottle(): void

- Defined in node_modules/rxjs/src/operator/auditTime.ts:57
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

AuditTimeSignature

__call(delay: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/auditTime.ts:19
Parameters
- delay: number
- Optional scheduler: Scheduler
Returns Observable<T>

auditTime

auditTime<T>(delay: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/auditTime.ts:15
method

auditTime

owner

Observable

Type parameters
- T
Parameters
- delay: number
- Default value scheduler: Scheduler = async
Returns Observable<T>

dispatchNext

dispatchNext<T>(subscriber: AuditTimeSubscriber<T>): void

- Defined in node_modules/rxjs/src/operator/auditTime.ts:72
Type parameters
- T
Parameters
- subscriber: AuditTimeSubscriber<T>
Returns void

"node_modules/rxjs/src/operator/buffer"

"node_modules/rxjs/src/operator/buffer":

BufferOperator

BufferOperator:

constructor

new BufferOperator(closingNotifier: Observable<any>): BufferOperator

- Defined in node_modules/rxjs/src/operator/buffer.ts:49
Parameters
- closingNotifier: Observable<any>
Returns BufferOperator

closingNotifier

closingNotifier: Observable<any>

call

call(subscriber: Subscriber<T[]>, source: any): any

- Defined in node_modules/rxjs/src/operator/buffer.ts:54
Parameters
- subscriber: Subscriber<T[]>
- source: any
Returns any

BufferSubscriber

BufferSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new BufferSubscriber(destination: Subscriber<T[]>, closingNotifier: Observable<any>): BufferSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/buffer.ts:65
Parameters
- destination: Subscriber<T[]>
- closingNotifier: Observable<any>
Returns BufferSubscriber

buffer

buffer: T[]

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/buffer.ts:72
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, any>): void

Inherited from OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:20
Parameters
- innerSub: InnerSubscriber<T, any>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, any>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, any>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/buffer.ts:76
Parameters
- outerValue: T
- innerValue: any
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, any>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferSignature

__call(closingNotifier: Observable<any>): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/buffer.ts:45
Parameters
- closingNotifier: Observable<any>
Returns Observable<T[]>

buffer

buffer<T>(closingNotifier: Observable<any>): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/buffer.ts:41
Buffers the source Observable values until closingNotifier emits.

Collects values from the past as an array, and emits that array only when another Observable emits.

Buffers the incoming Observable values until the given closingNotifier Observable emits a value, at which point it emits the buffer on the output Observable and starts a new buffer internally, awaiting the next time closingNotifier emits.

example

On every click, emit array of most recent interval events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var buffered = interval.buffer(clicks); buffered.subscribe(x => console.log(x));

see

bufferCount

see

bufferTime

see

bufferToggle

see

bufferWhen

see

window

method

buffer

owner

Observable

Type parameters
- T
Parameters
- closingNotifier: Observable<any>
 
 An Observable that signals the buffer to be emitted on the output Observable.
Returns Observable<T[]>

An Observable of buffers, which are arrays of values.

"node_modules/rxjs/src/operator/bufferCount"

"node_modules/rxjs/src/operator/bufferCount":

BufferCountOperator

BufferCountOperator:

constructor

new BufferCountOperator(bufferSize: number, startBufferEvery: number): BufferCountOperator

- Defined in node_modules/rxjs/src/operator/bufferCount.ts:53
Parameters
- bufferSize: number
- startBufferEvery: number
Returns BufferCountOperator

bufferSize

bufferSize: number

startBufferEvery

startBufferEvery: number

call

call(subscriber: Subscriber<T[]>, source: any): any

- Defined in node_modules/rxjs/src/operator/bufferCount.ts:57
Parameters
- subscriber: Subscriber<T[]>
- source: any
Returns any

BufferCountSubscriber

BufferCountSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new BufferCountSubscriber(destination: Subscriber<T[]>, bufferSize: number, startBufferEvery: number): BufferCountSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/bufferCount.ts:69
Parameters
- destination: Subscriber<T[]>
- bufferSize: number
- startBufferEvery: number
Returns BufferCountSubscriber

bufferSize

bufferSize: number

buffers

buffers: Array<T[]>

count

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

startBufferEvery

startBufferEvery: number

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/bufferCount.ts:102
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/bufferCount.ts:75
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferCountSignature

__call(bufferSize: number, startBufferEvery?: number): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/bufferCount.ts:49
Parameters
- bufferSize: number
- Optional startBufferEvery: number
Returns Observable<T[]>

bufferCount

bufferCount<T>(bufferSize: number, startBufferEvery?: number): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/bufferCount.ts:45
Buffers the source Observable values until the size hits the maximum bufferSize given.

Collects values from the past as an array, and emits that array only when its size reaches bufferSize.

Buffers a number of values from the source Observable by bufferSize then emits the buffer and clears it, and starts a new buffer each startBufferEvery values. If startBufferEvery is not provided or is null, then new buffers are started immediately at the start of the source and when each buffer closes and is emitted.

example

Emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2); buffered.subscribe(x => console.log(x));

example

On every click, emit the last two click events as an array var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferCount(2, 1); buffered.subscribe(x => console.log(x));

see

buffer

see

bufferTime

see

bufferToggle

see

bufferWhen

see

windowCount

method

bufferCount

owner

Observable

Type parameters
- T
Parameters
- bufferSize: number
 
 The maximum size of the buffer emitted.
- Default value startBufferEvery: number = null
Returns Observable<T[]>

An Observable of arrays of buffered values.

"node_modules/rxjs/src/operator/bufferTime"

"node_modules/rxjs/src/operator/bufferTime":

BufferTimeOperator

BufferTimeOperator:

constructor

new BufferTimeOperator(bufferTimeSpan: number, bufferCreationInterval: number, scheduler: Scheduler): BufferTimeOperator

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:58
Parameters
- bufferTimeSpan: number
- bufferCreationInterval: number
- scheduler: Scheduler
Returns BufferTimeOperator

bufferCreationInterval

bufferCreationInterval: number

bufferTimeSpan

bufferTimeSpan: number

scheduler

scheduler: Scheduler

call

call(subscriber: Subscriber<T[]>, source: any): any

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:64
Parameters
- subscriber: Subscriber<T[]>
- source: any
Returns any

BufferTimeSubscriber

BufferTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new BufferTimeSubscriber(destination: Subscriber<T[]>, bufferTimeSpan: number, bufferCreationInterval: number, scheduler: Scheduler): BufferTimeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/bufferTime.ts:84
Parameters
- destination: Subscriber<T[]>
- bufferTimeSpan: number
- bufferCreationInterval: number
- scheduler: Scheduler
Returns BufferTimeSubscriber

bufferCreationInterval

bufferCreationInterval: number

bufferTimeSpan

bufferTimeSpan: number

buffers

buffers: Array<T[]>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/bufferTime.ts:116
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/bufferTime.ts:111
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/bufferTime.ts:103
Parameters
- value: T
Returns void

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:124
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

closeBuffer

closeBuffer(buffer: T[]): void

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:134
Parameters
- buffer: T[]
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

openBuffer

openBuffer(): T[]

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:128
Returns T[]

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferTimeSignature

__call(bufferTimeSpan: number, bufferCreationInterval?: number, scheduler?: Scheduler): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:54
Parameters
- bufferTimeSpan: number
- Optional bufferCreationInterval: number
- Optional scheduler: Scheduler
Returns Observable<T[]>

DispatchArg

DispatchArg:

buffer

buffer: Array<T>

subscriber

subscriber: BufferTimeSubscriber<T>

CreationState

CreationState: object

Type declaration

bufferCreationInterval: number
bufferTimeSpan: number
scheduler: Scheduler
subscriber: BufferTimeSubscriber<T>

bufferTime

bufferTime<T>(bufferTimeSpan: number, bufferCreationInterval?: number, scheduler?: Scheduler): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:48
Buffers the source Observable values for a specific time period.

Collects values from the past as an array, and emits those arrays periodically in time.

Buffers values from the source for a specific time duration bufferTimeSpan. Unless the optional argument bufferCreationInterval is given, it emits and resets the buffer every bufferTimeSpan milliseconds. If bufferCreationInterval is given, this operator opens the buffer every bufferCreationInterval milliseconds and closes (emits and resets) the buffer every bufferTimeSpan milliseconds.

example

Every second, emit an array of the recent click events var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(1000); buffered.subscribe(x => console.log(x));

example

Every 5 seconds, emit the click events from the next 2 seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferTime(2000, 5000); buffered.subscribe(x => console.log(x));

see

buffer

see

bufferCount

see

bufferToggle

see

bufferWhen

see

{@link windowTime}

method

bufferTime

owner

Observable

Type parameters
- T
Parameters
- bufferTimeSpan: number
 
 The amount of time to fill each buffer array.
- Default value bufferCreationInterval: number = null
- Default value scheduler: Scheduler = async
Returns Observable<T[]>

An observable of arrays of buffered values.

dispatchBufferClose

dispatchBufferClose<T>(arg: DispatchArg<T>): void

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:170
Type parameters
- T
Parameters
- arg: DispatchArg<T>
Returns void

dispatchBufferCreation

dispatchBufferCreation<T>(state: CreationState): void

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:160
Type parameters
- T
Parameters
- state: CreationState
Returns void

dispatchBufferTimeSpanOnly

dispatchBufferTimeSpanOnly(state: any): void

- Defined in node_modules/rxjs/src/operator/bufferTime.ts:141
Parameters
- state: any
Returns void

"node_modules/rxjs/src/operator/bufferToggle"

"node_modules/rxjs/src/operator/bufferToggle":

BufferToggleOperator

BufferToggleOperator:

constructor

new BufferToggleOperator(openings: SubscribableOrPromise, closingSelector: function): BufferToggleOperator

- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:57
Parameters
- openings: SubscribableOrPromise
- closingSelector: function
  - - (value: O): SubscribableOrPromise
    - Parameters
      - value: O
      Returns SubscribableOrPromise
Returns BufferToggleOperator

closingSelector

closingSelector: function

Type declaration

- (value: O): SubscribableOrPromise
- Parameters
  - value: O
  Returns SubscribableOrPromise

openings

openings: SubscribableOrPromise

call

call(subscriber: Subscriber<T[]>, source: any): any

- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:63
Parameters
- subscriber: Subscriber<T[]>
- source: any
Returns any

BufferToggleSubscriber

BufferToggleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new BufferToggleSubscriber(destination: Subscriber<T[]>, openings: SubscribableOrPromise, closingSelector: function): BufferToggleSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:79
Parameters
- destination: Subscriber<T[]>
- openings: SubscribableOrPromise
- closingSelector: function
 - - (value: O): SubscribableOrPromise | void
 - Parameters
 - value: O
 Returns SubscribableOrPromise | void
Returns BufferToggleSubscriber

closingSelector

closingSelector: function

Type declaration

- (value: O): SubscribableOrPromise | void
- Parameters
  - value: O
  Returns SubscribableOrPromise | void

contexts

contexts: Array<BufferContext<T>>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

openings

openings: SubscribableOrPromise

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:108
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:96
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:88
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

closeBuffer

closeBuffer(context: BufferContext<T>): void

- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:143
Parameters
- context: BufferContext<T>
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, O>): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:127
Parameters
- innerSub: InnerSubscriber<T, O>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, O>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, O>
Returns void

notifyNext

notifyNext(outerValue: any, innerValue: O, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, O>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:121
Parameters
- outerValue: any
- innerValue: O
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, O>
Returns void

openBuffer

openBuffer(value: O): void

- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:131
Parameters
- value: O
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

trySubscribe

trySubscribe(closingNotifier: any): void

- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:155
Parameters
- closingNotifier: any
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferContext

BufferContext:

buffer

buffer: T[]

subscription

subscription: Subscription

BufferToggleSignature

__call<O>(openings: SubscribableOrPromise, closingSelector: function): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:53
Type parameters
- O
Parameters
- openings: SubscribableOrPromise
- closingSelector: function
 - - (value: O): SubscribableOrPromise
 - Parameters
 - value: O
 Returns SubscribableOrPromise
Returns Observable<T[]>

bufferToggle

bufferToggle<T, O>(openings: SubscribableOrPromise, closingSelector: function): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/bufferToggle.ts:48
Buffers the source Observable values starting from an emission from openings and ending when the output of closingSelector emits.

Collects values from the past as an array. Starts collecting only when opening emits, and calls the closingSelector function to get an Observable that tells when to close the buffer.

Buffers values from the source by opening the buffer via signals from an Observable provided to openings, and closing and sending the buffers when a Subscribable or Promise returned by the closingSelector function emits.

example

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var buffered = clicks.bufferToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ); buffered.subscribe(x => console.log(x));

see

buffer

see

bufferCount

see

bufferTime

see

bufferWhen

see

windowToggle

method

bufferToggle

owner

Observable

Type parameters
- T
- O
Parameters
- openings: SubscribableOrPromise
 
 A Subscribable or Promise of notifications to start new buffers.
- closingSelector: function
 
 A function that takes the value emitted by the openings observable and returns a Subscribable or Promise, which, when it emits, signals that the associated buffer should be emitted and cleared.
 - - (value: O): SubscribableOrPromise
 - Parameters
 - value: O
 Returns SubscribableOrPromise
Returns Observable<T[]>

An observable of arrays of buffered values.

"node_modules/rxjs/src/operator/bufferWhen"

"node_modules/rxjs/src/operator/bufferWhen":

BufferWhenOperator

BufferWhenOperator:

constructor

new BufferWhenOperator(closingSelector: function): BufferWhenOperator

- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:53
Parameters
- closingSelector: function
 - - (): Observable<any>
 - Returns Observable<any>
Returns BufferWhenOperator

closingSelector

closingSelector: function

Type declaration

- (): Observable<any>
- Returns Observable<any>

call

call(subscriber: Subscriber<T[]>, source: any): any

- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:58
Parameters
- subscriber: Subscriber<T[]>
- source: any
Returns any

BufferWhenSubscriber

BufferWhenSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new BufferWhenSubscriber(destination: Subscriber<T[]>, closingSelector: function): BufferWhenSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:71
Parameters
- destination: Subscriber<T[]>
- closingSelector: function
 - - (): Observable<any>
 - Returns Observable<any>
Returns BufferWhenSubscriber

buffer

buffer: T[]

closingSelector

closingSelector: function

Type declaration

- (): Observable<any>
- Returns Observable<any>

closingSubscription

closingSubscription: Subscription

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

subscribing

subscribing: boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:82
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:78
Parameters
- value: T
Returns void

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:90
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:101
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, any>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, any>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:95
Parameters
- outerValue: T
- innerValue: any
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, any>
Returns void

openBuffer

openBuffer(): void

- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:109
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

BufferWhenSignature

__call(closingSelector: function): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:49
Parameters
- closingSelector: function
 - - (): Observable<any>
 - Returns Observable<any>
Returns Observable<T[]>

bufferWhen

bufferWhen<T>(closingSelector: function): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/bufferWhen.ts:45
Buffers the source Observable values, using a factory function of closing Observables to determine when to close, emit, and reset the buffer.

Collects values from the past as an array. When it starts collecting values, it calls a function that returns an Observable that tells when to close the buffer and restart collecting.

Opens a buffer immediately, then closes the buffer when the observable returned by calling closingSelector function emits a value. When it closes the buffer, it immediately opens a new buffer and repeats the process.

example

Emit an array of the last clicks every [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var buffered = clicks.bufferWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000) ); buffered.subscribe(x => console.log(x));

see

buffer

see

bufferCount

see

bufferTime

see

bufferToggle

see

windowWhen

method

bufferWhen

owner

Observable

Type parameters
- T
Parameters
- closingSelector: function
 
 A function that takes no arguments and returns an Observable that signals buffer closure.
 - - (): Observable<any>
 - Returns Observable<any>
Returns Observable<T[]>

An observable of arrays of buffered values.

"node_modules/rxjs/src/operator/cache"

"node_modules/rxjs/src/operator/cache":

CacheSignature

__call(bufferSize?: number, windowTime?: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/cache.ts:20
Parameters
- Optional bufferSize: number
- Optional windowTime: number
- Optional scheduler: Scheduler
Returns Observable<T>

cache

cache<T>(bufferSize?: number, windowTime?: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/cache.ts:14
method

cache

owner

Observable

Type parameters
- T
Parameters
- Default value bufferSize: number = Number.POSITIVE_INFINITY
- Default value windowTime: number = Number.POSITIVE_INFINITY
- Optional scheduler: Scheduler
Returns Observable<T>

"node_modules/rxjs/src/operator/catch"

"node_modules/rxjs/src/operator/catch":

CatchOperator

CatchOperator:

constructor

new CatchOperator(selector: function): CatchOperator

- Defined in node_modules/rxjs/src/operator/catch.ts:26
Parameters
- selector: function
 - - (err: any, caught: Observable<any>): Observable<any>
 - Parameters
 - err: any
 - caught: Observable<any>
 Returns Observable<any>
Returns CatchOperator

caught

caught: Observable<any>

selector

selector: function

Type declaration

- (err: any, caught: Observable<any>): Observable<any>
- Parameters
 - err: any
 - caught: Observable<any>
 Returns Observable<any>

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/catch.ts:31
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

CatchSubscriber

CatchSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new CatchSubscriber(destination: Subscriber<any>, selector: function, caught: Observable<any>): CatchSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/catch.ts:41
Parameters
- destination: Subscriber<any>
- selector: function
 - - (err: any, caught: Observable<any>): Observable<any>
 - Parameters
 - err: any
 - caught: Observable<any>
 Returns Observable<any>
- caught: Observable<any>
Returns CatchSubscriber

caught

caught: Observable<any>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

selector

selector: function

Type declaration

- (err: any, caught: Observable<any>): Observable<any>
- Parameters
 - err: any
 - caught: Observable<any>
 Returns Observable<any>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_innerSub

_innerSub(result: Observable<any>): void

- Defined in node_modules/rxjs/src/operator/catch.ts:66
Parameters
- result: Observable<any>
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err: any): void

Overwrites Subscriber.error
- Defined in node_modules/rxjs/src/operator/catch.ts:51
Parameters
- err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

CatchSignature

__call<R>(selector: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/catch.ts:21
Type parameters
- R
Parameters
- selector: function
 - - (err: any, caught: Observable<T>): Observable<R>
 - Parameters
 - err: any
 - caught: Observable<T>
 Returns Observable<R>
Returns Observable<R>

_catch

_catch<T, R>(selector: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/catch.ts:15
Catches errors on the observable to be handled by returning a new observable or throwing an error.

method

catch

owner

Observable

Type parameters
- T
- R
Parameters
- selector: function
 
 a function that takes as arguments err, which is the error, and caught, which is the source observable, in case you'd like to "retry" that observable by returning it again. Whatever observable is returned by the selector will be used to continue the observable chain.
 - - (err: any, caught: Observable<T>): Observable<R>
 - Parameters
 - err: any
 - caught: Observable<T>
 Returns Observable<R>
Returns Observable<R>

an observable that originates from either the source or the observable returned by the catch selector function.

"node_modules/rxjs/src/operator/combineAll"

"node_modules/rxjs/src/operator/combineAll":

CombineAllSignature

__call(): Observable<T[]>
__call<R>(project?: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/combineAll.ts:48
Returns Observable<T[]>
- Defined in node_modules/rxjs/src/operator/combineAll.ts:49
Type parameters
- R
Parameters
- Optional project: function
 - - (...values: Array<T>): R
 - Parameters
 - Rest ...values: Array<T>
 Returns R
Returns Observable<R>

combineAll

combineAll<R>(project?: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/combineAll.ts:44
Converts a higher-order Observable into a first-order Observable by waiting for the outer Observable to complete, then applying combineLatest.

Flattens an Observable-of-Observables by applying combineLatest when the Observable-of-Observables completes.

Takes an Observable of Observables, and collects all Observables from it. Once the outer Observable completes, it subscribes to all collected Observables and combines their values using the combineLatest strategy, such that:
- Every time an inner Observable emits, the output Observable emits.
- When the returned observable emits, it emits all of the latest values by:
 - If a project function is provided, it is called with each recent value from each inner Observable in whatever order they arrived, and the result of the project function is what is emitted by the output Observable.
 - If there is no project function, an array of all of the most recent values is emitted by the output Observable.
example

Map two click events to a finite interval Observable, then apply combineAll var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(Math.random()*2000).take(3) ).take(2); var result = higherOrder.combineAll(); result.subscribe(x => console.log(x));

see

combineLatest

see

mergeAll

method

combineAll

owner

Observable
Type parameters
- R
Parameters
- Optional project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
Returns Observable<R>

An Observable of projected results or arrays of recent values.

"node_modules/rxjs/src/operator/combineLatest"

"node_modules/rxjs/src/operator/combineLatest":

CombineLatestOperator

CombineLatestOperator:

constructor

new CombineLatestOperator(project?: function): CombineLatestOperator

- Defined in node_modules/rxjs/src/operator/combineLatest.ts:145
Parameters
- Optional project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
Returns CombineLatestOperator

project

project: function

Type declaration

- (...values: Array<any>): R
- Parameters
 - Rest ...values: Array<any>
 Returns R

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/combineLatest.ts:149
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

CombineLatestSubscriber

CombineLatestSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new CombineLatestSubscriber(destination: Subscriber<R>, project?: function): CombineLatestSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:163
Parameters
- destination: Subscriber<R>
- Optional project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
Returns CombineLatestSubscriber

active

active: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

observables

observables: any[]

project

project: function

Type declaration

- (...values: Array<any>): R
- Parameters
 - Rest ...values: Array<any>
 Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

toRespond

toRespond: number[]

values

values: any[]

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:175
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(observable: any): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:169
Parameters
- observable: any
Returns void

_tryProject

_tryProject(values: any[]): void

- Defined in node_modules/rxjs/src/operator/combineLatest.ts:218
Parameters
- values: any[]
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(unused: Subscriber<R>): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:189
Parameters
- unused: Subscriber<R>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:195
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

CombineLatestSignature

__call<R>(project: function): Observable<R>
__call<T2, R>(v2: ObservableInput, project: function): Observable<R>
__call<T2, T3, R>(v2: ObservableInput, v3: ObservableInput, project: function): Observable<R>
__call<T2, T3, T4, R>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, project: function): Observable<R>
__call<T2, T3, T4, T5, R>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, project: function): Observable<R>
__call<T2, T3, T4, T5, T6, R>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, project: function): Observable<R>
__call<T2>(v2: ObservableInput): Observable<[T, T2]>
__call<T2, T3>(v2: ObservableInput, v3: ObservableInput): Observable<[T, T2, T3]>
__call<T2, T3, T4>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput): Observable<[T, T2, T3, T4]>
__call<T2, T3, T4, T5>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput): Observable<[T, T2, T3, T4, T5]>
__call<T2, T3, T4, T5, T6>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput): Observable<[T, T2, T3, T4, T5, T6]>
__call<R>(...observables: Array<ObservableInput | function>): Observable<R>
__call<R>(array: ObservableInput[]): Observable<R>
__call<R>(array: ObservableInput[], project: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/combineLatest.ts:70
Type parameters
- R
Parameters
- project: function
 - - (v1: T): R
 - Parameters
 - v1: T
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:71
Type parameters
- T2
- R
Parameters
- v2: ObservableInput
- project: function
 - - (v1: T, v2: T2): R
 - Parameters
 - v1: T
 - v2: T2
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:72
Type parameters
- T2
- T3
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:73
Type parameters
- T2
- T3
- T4
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:74
Type parameters
- T2
- T3
- T4
- T5
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:75
Type parameters
- T2
- T3
- T4
- T5
- T6
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:76
Type parameters
- T2
Parameters
- v2: ObservableInput
Returns Observable<[T, T2]>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:78
Type parameters
- T2
- T3
Parameters
- v2: ObservableInput
- v3: ObservableInput
Returns Observable<[T, T2, T3]>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:79
Type parameters
- T2
- T3
- T4
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
Returns Observable<[T, T2, T3, T4]>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:80
Type parameters
- T2
- T3
- T4
- T5
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
Returns Observable<[T, T2, T3, T4, T5]>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:81
Type parameters
- T2
- T3
- T4
- T5
- T6
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
Returns Observable<[T, T2, T3, T4, T5, T6]>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:82
Type parameters
- R
Parameters
- Rest ...observables: Array<ObservableInput | function>
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:84
Type parameters
- R
Parameters
- array: ObservableInput[]
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:85
Type parameters
- R
Parameters
- array: ObservableInput[]
- project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
Returns Observable<R>

combineLatest

combineLatest<T, R>(...observables: Array<ObservableInput | Array<ObservableInput> | function>): Observable<R>

- Defined in node_modules/rxjs/src/operator/combineLatest.ts:50
Combines multiple Observables to create an Observable whose values are calculated from the latest values of each of its input Observables.

Whenever any input Observable emits a value, it computes a formula using the latest values from all the inputs, then emits the output of that formula.

combineLatest combines the values from this Observable with values from Observables passed as arguments. This is done by subscribing to each Observable, in order, and collecting an array of each of the most recent values any time any of the input Observables emits, then either taking that array and passing it as arguments to an optional project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

example

Dynamically calculate the Body-Mass Index from an Observable of weight and one for height var weight = Rx.Observable.of(70, 72, 76, 79, 75); var height = Rx.Observable.of(1.76, 1.77, 1.78); var bmi = weight.combineLatest(height, (w, h) => w / (h * h)); bmi.subscribe(x => console.log('BMI is ' + x));

see

combineAll

see

merge

see

withLatestFrom

method

combineLatest

owner

Observable

Type parameters
- T
- R
Parameters
- Rest ...observables: Array<ObservableInput | Array<ObservableInput> | function>
Returns Observable<R>

An Observable of projected values from the most recent values from each input Observable, or an array of the most recent values from each input Observable.

combineLatestStatic

combineLatestStatic<T>(v1: ObservableInput, scheduler?: Scheduler): Observable<[T]>
combineLatestStatic<T, T2>(v1: ObservableInput, v2: ObservableInput, scheduler?: Scheduler): Observable<[T, T2]>
combineLatestStatic<T, T2, T3>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, scheduler?: Scheduler): Observable<[T, T2, T3]>
combineLatestStatic<T, T2, T3, T4>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, scheduler?: Scheduler): Observable<[T, T2, T3, T4]>
combineLatestStatic<T, T2, T3, T4, T5>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, scheduler?: Scheduler): Observable<[T, T2, T3, T4, T5]>
combineLatestStatic<T, T2, T3, T4, T5, T6>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, scheduler?: Scheduler): Observable<[T, T2, T3, T4, T5, T6]>
combineLatestStatic<T, R>(v1: ObservableInput, project: function, scheduler?: Scheduler): Observable<R>
combineLatestStatic<T, T2, R>(v1: ObservableInput, v2: ObservableInput, project: function, scheduler?: Scheduler): Observable<R>
combineLatestStatic<T, T2, T3, R>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, project: function, scheduler?: Scheduler): Observable<R>
combineLatestStatic<T, T2, T3, T4, R>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, project: function, scheduler?: Scheduler): Observable<R>
combineLatestStatic<T, T2, T3, T4, T5, R>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, project: function, scheduler?: Scheduler): Observable<R>
combineLatestStatic<T, T2, T3, T4, T5, T6, R>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, project: function, scheduler?: Scheduler): Observable<R>
combineLatestStatic<R>(...observables: Array<ObservableInput | function | Scheduler>): Observable<R>
combineLatestStatic<R>(array: ObservableInput[], scheduler?: Scheduler): Observable<R>
combineLatestStatic<R>(array: ObservableInput[], project: function, scheduler?: Scheduler): Observable<R>

- Defined in node_modules/rxjs/src/operator/combineLatest.ts:91
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
Parameters
- v1: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<[T]>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:92
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
Parameters
- v1: ObservableInput
- v2: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<[T, T2]>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:93
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
- T3
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<[T, T2, T3]>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:94
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
- T3
- T4
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<[T, T2, T3, T4]>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:95
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
- T3
- T4
- T5
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<[T, T2, T3, T4, T5]>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:96
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
- T3
- T4
- T5
- T6
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<[T, T2, T3, T4, T5, T6]>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:97
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- R
Parameters
- v1: ObservableInput
- project: function
 - - (v1: T): R
 - Parameters
 - v1: T
 Returns R
- Optional scheduler: Scheduler
Returns Observable<R>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:98
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- project: function
 - - (v1: T, v2: T2): R
 - Parameters
 - v1: T
 - v2: T2
 Returns R
- Optional scheduler: Scheduler
Returns Observable<R>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:99
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
- T3
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 Returns R
- Optional scheduler: Scheduler
Returns Observable<R>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:100
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
- T3
- T4
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 Returns R
- Optional scheduler: Scheduler
Returns Observable<R>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:101
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
- T3
- T4
- T5
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 Returns R
- Optional scheduler: Scheduler
Returns Observable<R>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:102
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- T
- T2
- T3
- T4
- T5
- T6
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 Returns R
- Optional scheduler: Scheduler
Returns Observable<R>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:103
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- R
Parameters
- Rest ...observables: Array<ObservableInput | function | Scheduler>
 
 the observables to combine
Returns Observable<R>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:104
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- R
Parameters
- array: ObservableInput[]
- Optional scheduler: Scheduler
Returns Observable<R>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.
- Defined in node_modules/rxjs/src/operator/combineLatest.ts:105
Combines the values from observables passed as arguments. This is done by subscribing to each observable, in order, and collecting an array of each of the most recent values any time any of the observables emits, then either taking that array and passing it as arguments to an option project function and emitting the return value of that, or just emitting the array of recent values directly if there is no project function.

Type parameters
- R
Parameters
- array: ObservableInput[]
- project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
- Optional scheduler: Scheduler
Returns Observable<R>

an observable of other projected values from the most recent values from each observable, or an array of each of the most recent values from each observable.

"node_modules/rxjs/src/operator/concat"

"node_modules/rxjs/src/operator/concat":

ConcatSignature

__call(scheduler?: Scheduler): Observable<T>
__call<T2>(v2: ObservableInput, scheduler?: Scheduler): Observable<T | T2>
__call<T2, T3>(v2: ObservableInput, v3: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3>
__call<T2, T3, T4>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4>
__call<T2, T3, T4, T5>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5>
__call<T2, T3, T4, T5, T6>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5 | T6>
__call(...observables: Array<ObservableInput | Scheduler>): Observable<T>
__call<R>(...observables: Array<ObservableInput | Scheduler>): Observable<R>

- Defined in node_modules/rxjs/src/operator/concat.ts:52
Parameters
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/concat.ts:53
Type parameters
- T2
Parameters
- v2: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2>
- Defined in node_modules/rxjs/src/operator/concat.ts:54
Type parameters
- T2
- T3
Parameters
- v2: ObservableInput
- v3: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3>
- Defined in node_modules/rxjs/src/operator/concat.ts:55
Type parameters
- T2
- T3
- T4
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4>
- Defined in node_modules/rxjs/src/operator/concat.ts:56
Type parameters
- T2
- T3
- T4
- T5
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5>
- Defined in node_modules/rxjs/src/operator/concat.ts:57
Type parameters
- T2
- T3
- T4
- T5
- T6
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5 | T6>
- Defined in node_modules/rxjs/src/operator/concat.ts:58
Parameters
- Rest ...observables: Array<ObservableInput | Scheduler>
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/concat.ts:59
Type parameters
- R
Parameters
- Rest ...observables: Array<ObservableInput | Scheduler>
Returns Observable<R>

concat

concat<T, R>(...observables: Array<ObservableInput | Scheduler>): Observable<R>

- Defined in node_modules/rxjs/src/operator/concat.ts:47
Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins this Observable with multiple other Observables by subscribing to them one at a time, starting with the source, and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

example

Concatenate a timer counting from 0 to 3 with a synchronous sequence from 1 to 10 var timer = Rx.Observable.interval(1000).take(4); var sequence = Rx.Observable.range(1, 10); var result = timer.concat(sequence); result.subscribe(x => console.log(x));

example

Concatenate 3 Observables var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var result = timer1.concat(timer2, timer3); result.subscribe(x => console.log(x));

see

concatAll

see

concatMap

see

concatMapTo

method

concat

owner

Observable

Type parameters
- T
- R
Parameters
- Rest ...observables: Array<ObservableInput | Scheduler>
Returns Observable<R>

All values of each passed Observable merged into a single Observable, in order, in serial fashion.

concatStatic

concatStatic<T>(v1: ObservableInput, scheduler?: Scheduler): Observable<T>
concatStatic<T, T2>(v1: ObservableInput, v2: ObservableInput, scheduler?: Scheduler): Observable<T | T2>
concatStatic<T, T2, T3>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3>
concatStatic<T, T2, T3, T4>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4>
concatStatic<T, T2, T3, T4, T5>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5>
concatStatic<T, T2, T3, T4, T5, T6>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5 | T6>
concatStatic<T>(...observables: Subscribable<T> | Promise<T> | ArrayLike<T> | Scheduler): Observable<T>
concatStatic<T, R>(...observables: Subscribable<any> | Promise<any> | ArrayLike<any> | Scheduler): Observable<R>

- Defined in node_modules/rxjs/src/operator/concat.ts:65
Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Type parameters
- T
Parameters
- v1: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T>

All values of each passed Observable merged into a single Observable, in order, in serial fashion.
- Defined in node_modules/rxjs/src/operator/concat.ts:66
Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Type parameters
- T
- T2
Parameters
- v1: ObservableInput
- v2: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2>

All values of each passed Observable merged into a single Observable, in order, in serial fashion.
- Defined in node_modules/rxjs/src/operator/concat.ts:67
Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Type parameters
- T
- T2
- T3
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3>

All values of each passed Observable merged into a single Observable, in order, in serial fashion.
- Defined in node_modules/rxjs/src/operator/concat.ts:68
Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Type parameters
- T
- T2
- T3
- T4
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4>

All values of each passed Observable merged into a single Observable, in order, in serial fashion.
- Defined in node_modules/rxjs/src/operator/concat.ts:69
Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Type parameters
- T
- T2
- T3
- T4
- T5
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5>

All values of each passed Observable merged into a single Observable, in order, in serial fashion.
- Defined in node_modules/rxjs/src/operator/concat.ts:70
Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Type parameters
- T
- T2
- T3
- T4
- T5
- T6
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5 | T6>

All values of each passed Observable merged into a single Observable, in order, in serial fashion.
- Defined in node_modules/rxjs/src/operator/concat.ts:71
Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Type parameters
- T
Parameters
- Rest ...observables: Subscribable<T> | Promise<T> | ArrayLike<T> | Scheduler
Returns Observable<T>

All values of each passed Observable merged into a single Observable, in order, in serial fashion.
- Defined in node_modules/rxjs/src/operator/concat.ts:72
Creates an output Observable which sequentially emits all values from every given input Observable after the current Observable.

Concatenates multiple Observables together by sequentially emitting their values, one Observable after the other.

Joins multiple Observables together by subscribing to them one at a time and merging their results into the output Observable. Will wait for each Observable to complete before moving on to the next.

Type parameters
- T
- R
Parameters
- Rest ...observables: Subscribable<any> | Promise<any> | ArrayLike<any> | Scheduler
Returns Observable<R>

All values of each passed Observable merged into a single Observable, in order, in serial fashion.

"node_modules/rxjs/src/operator/concatAll"

"node_modules/rxjs/src/operator/concatAll":

ConcatAllSignature

__call(): T
__call<R>(): Subscribable<R>

- Defined in node_modules/rxjs/src/operator/concatAll.ts:50
Returns T
- Defined in node_modules/rxjs/src/operator/concatAll.ts:51
Type parameters
- R
Returns Subscribable<R>

concatAll

concatAll<T>(): T

- Defined in node_modules/rxjs/src/operator/concatAll.ts:46
Converts a higher-order Observable into a first-order Observable by concatenating the inner Observables in order.

Flattens an Observable-of-Observables by putting one inner Observable after the other.

Joins every Observable emitted by the source (a higher-order Observable), in a serial fashion. It subscribes to each inner Observable only after the previous inner Observable has completed, and merges all of their values into the returned observable.

Warning: If the source Observable emits Observables quickly and endlessly, and the inner Observables it emits generally complete slower than the source emits, you can run into memory issues as the incoming Observables collect in an unbounded buffer.

Note: concatAll is equivalent to mergeAll with concurrency parameter set to 1.

example

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map(ev => Rx.Observable.interval(1000).take(4)); var firstOrder = higherOrder.concatAll(); firstOrder.subscribe(x => console.log(x));

see

combineAll

see

concat

see

concatMap

see

concatMapTo

see

exhaust

see

mergeAll

see

switch

see

zipAll

method

concatAll

owner

Observable

Type parameters
- T
Returns T

An Observable emitting values from all the inner Observables concatenated.

"node_modules/rxjs/src/operator/concatMap"

"node_modules/rxjs/src/operator/concatMap":

ConcatMapSignature

__call<R>(project: function): Observable<R>
__call<I, R>(project: function, resultSelector: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/concatMap.ts:65
Type parameters
- R
Parameters
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/concatMap.ts:66
Type parameters
- I
- R
Parameters
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns Observable<R>

concatMap

concatMap<T, I, R>(project: function, resultSelector?: function): any

- Defined in node_modules/rxjs/src/operator/concatMap.ts:60
Projects each source value to an Observable which is merged in the output Observable, in a serialized fashion waiting for each one to complete before merging the next.

Maps each value to an Observable, then flattens all of these inner Observables using concatAll.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each new inner Observable is concatenated with the previous inner Observable.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMap is equivalent to mergeMap with concurrency parameter set to 1.

example

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMap(ev => Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

see

concat

see

concatAll

see

concatMapTo

see

exhaustMap

see

mergeMap

see

switchMap

method

concatMap

owner

Observable

Type parameters
- T
- I
- R
Parameters
- project: function
  
  A function that, when applied to an item emitted by the source Observable, returns an Observable.
  - - (value: T, index: number): ObservableInput
    - Parameters
      - value: T
      - index: number
      Returns ObservableInput
- Optional resultSelector: function
  - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
    - Parameters
      - outerValue: T
      - innerValue: I
      - outerIndex: number
      - innerIndex: number
      Returns R
Returns any

an observable of values merged from the projected Observables as they were subscribed to, one at a time. Optionally, these values may have been projected from a passed projectResult argument.

"node_modules/rxjs/src/operator/concatMapTo"

"node_modules/rxjs/src/operator/concatMapTo":

ConcatMapToSignature

__call<R>(observable: ObservableInput): Observable<R>
__call<I, R>(observable: ObservableInput, resultSelector: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/concatMapTo.ts:59
Type parameters
- R
Parameters
- observable: ObservableInput
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/concatMapTo.ts:60
Type parameters
- I
- R
Parameters
- observable: ObservableInput
- resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns Observable<R>

concatMapTo

concatMapTo<T, I, R>(innerObservable: Observable, resultSelector?: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/concatMapTo.ts:54
Projects each source value to the same Observable which is merged multiple times in a serialized fashion on the output Observable.

It's like concatMap, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. Each new innerObservable instance emitted on the output Observable is concatenated with the previous innerObservable instance.

Warning: if source values arrive endlessly and faster than their corresponding inner Observables can complete, it will result in memory issues as inner Observables amass in an unbounded buffer waiting for their turn to be subscribed to.

Note: concatMapTo is equivalent to mergeMapTo with concurrency parameter set to 1.

example

For each click event, tick every second from 0 to 3, with no concurrency var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.concatMapTo(Rx.Observable.interval(1000).take(4)); result.subscribe(x => console.log(x));

see

concat

see

concatAll

see

concatMap

see

mergeMapTo

see

switchMapTo

method

concatMapTo

owner

Observable

Type parameters
- T
- I
- R
Parameters
- innerObservable: Observable
 
 An Observable to replace each value from the source Observable.
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns Observable<R>

An observable of values merged together by joining the passed observable with itself, one after the other, for each value emitted from the source.

"node_modules/rxjs/src/operator/count"

"node_modules/rxjs/src/operator/count":

CountOperator

CountOperator:

constructor

new CountOperator(predicate?: function, source?: Observable<T>): CountOperator

- Defined in node_modules/rxjs/src/operator/count.ts:59
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional source: Observable<T>
Returns CountOperator

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

source

source: Observable<T>

call

call(subscriber: Subscriber<number>, source: any): any

- Defined in node_modules/rxjs/src/operator/count.ts:64
Parameters
- subscriber: Subscriber<number>
- source: any
Returns any

CountSubscriber

CountSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new CountSubscriber(destination: Observer<number>, predicate?: function, source?: Observable<T>): CountSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/count.ts:76
Parameters
- destination: Observer<number>
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional source: Observable<T>
Returns CountSubscriber

count

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/count.ts:107
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/count.ts:84
Parameters
- value: T
Returns void

_tryPredicate

_tryPredicate(value: T): void

- Defined in node_modules/rxjs/src/operator/count.ts:92
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

CountSignature

__call(predicate?: function): Observable<number>

- Defined in node_modules/rxjs/src/operator/count.ts:55
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
Returns Observable<number>

count

count<T>(predicate?: function): Observable<number>

- Defined in node_modules/rxjs/src/operator/count.ts:51
Counts the number of emissions on the source and emits that number when the source completes.

Tells how many values were emitted, when the source completes.

count transforms an Observable that emits values into an Observable that emits a single value that represents the number of values emitted by the source Observable. If the source Observable terminates with an error, count will pass this error notification along without emitting an value first. If the source Observable does not terminate at all, count will neither emit a value nor terminate. This operator takes an optional predicate function as argument, in which case the output emission will represent the number of source values that matched true with the predicate.

example

Counts how many seconds have passed before the first click happened var seconds = Rx.Observable.interval(1000); var clicks = Rx.Observable.fromEvent(document, 'click'); var secondsBeforeClick = seconds.takeUntil(clicks); var result = secondsBeforeClick.count(); result.subscribe(x => console.log(x));

example

Counts how many odd numbers are there between 1 and 7 var numbers = Rx.Observable.range(1, 7); var result = numbers.count(i => i % 2 === 1); result.subscribe(x => console.log(x));

see

max

see

{@link min}

see

reduce

method

count

owner

Observable

Type parameters
- T
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
Returns Observable<number>

An Observable of one number that represents the count as described above.

"node_modules/rxjs/src/operator/debounce"

"node_modules/rxjs/src/operator/debounce":

DebounceOperator

DebounceOperator:

constructor

new DebounceOperator(durationSelector: function): DebounceOperator

- Defined in node_modules/rxjs/src/operator/debounce.ts:30
Parameters
- durationSelector: function
  - - (value: T): SubscribableOrPromise
    - Parameters
      - value: T
      Returns SubscribableOrPromise
Returns DebounceOperator

durationSelector

durationSelector: function

Type declaration

- (value: T): SubscribableOrPromise
- Parameters
  - value: T
  Returns SubscribableOrPromise

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/debounce.ts:34
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

DebounceSubscriber

DebounceSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new DebounceSubscriber(destination: Subscriber<R>, durationSelector: function): DebounceSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/debounce.ts:47
Parameters
- destination: Subscriber<R>
- durationSelector: function
 - - (value: T): SubscribableOrPromise
 - Parameters
 - value: T
 Returns SubscribableOrPromise
Returns DebounceSubscriber

destination

destination: PartialObserver

durationSelector

durationSelector: function

Type declaration

- (value: T): SubscribableOrPromise
- Parameters
  - value: T
  Returns SubscribableOrPromise

durationSubscription

durationSubscription: Subscription

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

value

value: T

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/debounce.ts:66
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/debounce.ts:54
Parameters
- value: T
Returns void

_tryNext

_tryNext(value: T, duration: SubscribableOrPromise): void

- Defined in node_modules/rxjs/src/operator/debounce.ts:71
Parameters
- value: T
- duration: SubscribableOrPromise
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

emitValue

emitValue(): void

- Defined in node_modules/rxjs/src/operator/debounce.ts:96
Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/debounce.ts:92
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/debounce.ts:86
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DebounceSignature

__call(durationSelector: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/debounce.ts:26
Parameters
- durationSelector: function
 - - (value: T): SubscribableOrPromise
 - Parameters
 - value: T
 Returns SubscribableOrPromise
Returns Observable<T>

debounce

debounce<T>(durationSelector: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/debounce.ts:22
Returns the source Observable delayed by the computed debounce duration, with the duration lengthened if a new source item arrives before the delay duration ends. In practice, for each item emitted on the source, this operator holds the latest item, waits for a silence as long as the durationSelector specifies, and only then emits the latest source item on the result Observable.

method

debounce

owner

Observable

Type parameters
- T
Parameters
- durationSelector: function
 
 function for computing the timeout duration for each item.
 - - (value: T): SubscribableOrPromise
 - Parameters
 - value: T
 Returns SubscribableOrPromise
Returns Observable<T>

an Observable the same as source Observable, but drops items.

"node_modules/rxjs/src/operator/debounceTime"

"node_modules/rxjs/src/operator/debounceTime":

DebounceTimeOperator

DebounceTimeOperator:

constructor

new DebounceTimeOperator(dueTime: number, scheduler: Scheduler): DebounceTimeOperator

- Defined in node_modules/rxjs/src/operator/debounceTime.ts:30
Parameters
- dueTime: number
- scheduler: Scheduler
Returns DebounceTimeOperator

dueTime

dueTime: number

scheduler

scheduler: Scheduler

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/debounceTime.ts:34
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

DebounceTimeSubscriber

DebounceTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new DebounceTimeSubscriber(destination: Subscriber<T>, dueTime: number, scheduler: Scheduler): DebounceTimeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/debounceTime.ts:47
Parameters
- destination: Subscriber<T>
- dueTime: number
- scheduler: Scheduler
Returns DebounceTimeSubscriber

debouncedSubscription

debouncedSubscription: Subscription

destination

destination: PartialObserver

dueTime

dueTime: number

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

lastValue

lastValue: T

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/debounceTime.ts:62
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/debounceTime.ts:55
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

clearDebounce

clearDebounce(): void

- Defined in node_modules/rxjs/src/operator/debounceTime.ts:77
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

debouncedNext

debouncedNext(): void

- Defined in node_modules/rxjs/src/operator/debounceTime.ts:67
Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DebounceTimeSignature

__call(dueTime: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/debounceTime.ts:26
Parameters
- dueTime: number
- Optional scheduler: Scheduler
Returns Observable<T>

debounceTime

debounceTime<T>(dueTime: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/debounceTime.ts:22
Returns the source Observable delayed by the computed debounce duration, with the duration lengthened if a new source item arrives before the delay duration ends. In practice, for each item emitted on the source, this operator holds the latest item, waits for a silence for the dueTime length, and only then emits the latest source item on the result Observable. Optionally takes a scheduler for manging timers.

method

debounceTime

owner

Observable

Type parameters
- T
Parameters
- dueTime: number
 
 the timeout value for the window of time required to not drop the item.
- Default value scheduler: Scheduler = async
Returns Observable<T>

an Observable the same as source Observable, but drops items.

dispatchNext

dispatchNext(subscriber: DebounceTimeSubscriber<any>): void

- Defined in node_modules/rxjs/src/operator/debounceTime.ts:88
Parameters
- subscriber: DebounceTimeSubscriber<any>
Returns void

"node_modules/rxjs/src/operator/defaultIfEmpty"

"node_modules/rxjs/src/operator/defaultIfEmpty":

DefaultIfEmptyOperator

DefaultIfEmptyOperator:

constructor

new DefaultIfEmptyOperator(defaultValue: R): DefaultIfEmptyOperator

- Defined in node_modules/rxjs/src/operator/defaultIfEmpty.ts:21
Parameters
- defaultValue: R
Returns DefaultIfEmptyOperator

defaultValue

defaultValue: R

call

call(subscriber: Subscriber<T | R>, source: any): any

- Defined in node_modules/rxjs/src/operator/defaultIfEmpty.ts:26
Parameters
- subscriber: Subscriber<T | R>
- source: any
Returns any

DefaultIfEmptySubscriber

DefaultIfEmptySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new DefaultIfEmptySubscriber(destination: Subscriber<T | R>, defaultValue: R): DefaultIfEmptySubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/defaultIfEmpty.ts:37
Parameters
- destination: Subscriber<T | R>
- defaultValue: R
Returns DefaultIfEmptySubscriber

defaultValue

defaultValue: R

destination

destination: PartialObserver

isEmpty

isEmpty: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/defaultIfEmpty.ts:48
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/defaultIfEmpty.ts:43
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DefaultIfEmptySignature

__call(defaultValue?: T): Observable<T>
__call<R>(defaultValue?: R): Observable<T | R>

- Defined in node_modules/rxjs/src/operator/defaultIfEmpty.ts:16
Parameters
- Optional defaultValue: T
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/defaultIfEmpty.ts:17
Type parameters
- R
Parameters
- Optional defaultValue: R
Returns Observable<T | R>

defaultIfEmpty

defaultIfEmpty<T, R>(defaultValue?: R): Observable<T | R>

- Defined in node_modules/rxjs/src/operator/defaultIfEmpty.ts:12
Returns an Observable that emits the elements of the source or a specified default value if empty.

method

defaultIfEmpty

owner

Observable

Type parameters
- T
- R
Parameters
- Default value defaultValue: R = null
 
 the default value used if source is empty; defaults to null.
Returns Observable<T | R>

an Observable of the items emitted by the where empty values are replaced by the specified default value or null.

"node_modules/rxjs/src/operator/delay"

"node_modules/rxjs/src/operator/delay":

DelayMessage

DelayMessage:

constructor

new DelayMessage(time: number, notification: any): DelayMessage

- Defined in node_modules/rxjs/src/operator/delay.ts:139
Parameters
- time: number
- notification: any
Returns DelayMessage

notification

notification: any

time

time: number

DelayOperator

DelayOperator:

constructor

new DelayOperator(delay: number, scheduler: Scheduler): DelayOperator

- Defined in node_modules/rxjs/src/operator/delay.ts:59
Parameters
- delay: number
- scheduler: Scheduler
Returns DelayOperator

delay

delay: number

scheduler

scheduler: Scheduler

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/delay.ts:64
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

DelaySubscriber

DelaySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new DelaySubscriber(destination: Subscriber<T>, delay: number, scheduler: Scheduler): DelaySubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/delay.ts:95
Parameters
- destination: Subscriber<T>
- delay: number
- scheduler: Scheduler
Returns DelaySubscriber

active

active: boolean

delay

delay: number

destination

destination: PartialObserver

errored

errored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

queue

queue: Array<any>

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/delay.ts:134
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/delay.ts:128
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/delay.ts:124
Parameters
- value: T
Returns void

_schedule

_schedule(scheduler: Scheduler): void

- Defined in node_modules/rxjs/src/operator/delay.ts:103
Parameters
- scheduler: Scheduler
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

scheduleNotification

scheduleNotification(notification: Notification<any>): void

- Defined in node_modules/rxjs/src/operator/delay.ts:110
Parameters
- notification: Notification<any>
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatch

dispatch(state: any): void

- Defined in node_modules/rxjs/src/operator/delay.ts:79
Parameters
- state: any
Returns void

DelaySignature

__call(delay: number | Date, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/delay.ts:55
Parameters
- delay: number | Date
- Optional scheduler: Scheduler
Returns Observable<T>

delay

delay<T>(delay: number | Date, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/delay.ts:48
Delays the emission of items from the source Observable by a given timeout or until a given Date.

Time shifts each item by some specified amount of milliseconds.

If the delay argument is a Number, this operator time shifts the source Observable by that amount of time expressed in milliseconds. The relative time intervals between the values are preserved.

If the delay argument is a Date, this operator time shifts the start of the Observable execution until the given date occurs.

example

Delay each click by one second var clicks = Rx.Observable.fromEvent(document, 'click'); var delayedClicks = clicks.delay(1000); // each click emitted after 1 second delayedClicks.subscribe(x => console.log(x));

example

Delay all clicks until a future date happens var clicks = Rx.Observable.fromEvent(document, 'click'); var date = new Date('March 15, 2050 12:00:00'); // in the future var delayedClicks = clicks.delay(date); // click emitted only after that date delayedClicks.subscribe(x => console.log(x));

see

debounceTime

see

delayWhen

method

delay

owner

Observable

Type parameters
- T
Parameters
- delay: number | Date
 
 The delay duration in milliseconds (a number) or a Date until which the emission of the source items is delayed.
- Default value scheduler: Scheduler = async
Returns Observable<T>

An Observable that delays the emissions of the source Observable by the specified timeout or Date.

"node_modules/rxjs/src/operator/delayWhen"

"node_modules/rxjs/src/operator/delayWhen":

DelayWhenOperator

DelayWhenOperator:

constructor

new DelayWhenOperator(delayDurationSelector: function): DelayWhenOperator

- Defined in node_modules/rxjs/src/operator/delayWhen.ts:32
Parameters
- delayDurationSelector: function
 - - (value: T): Observable<any>
 - Parameters
 - value: T
 Returns Observable<any>
Returns DelayWhenOperator

delayDurationSelector

delayDurationSelector: function

Type declaration

- (value: T): Observable<any>
- Parameters
 - value: T
 Returns Observable<any>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/delayWhen.ts:36
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

DelayWhenSubscriber

DelayWhenSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new DelayWhenSubscriber(destination: Subscriber<T>, delayDurationSelector: function): DelayWhenSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:49
Parameters
- destination: Subscriber<T>
- delayDurationSelector: function
 - - (value: T): Observable<any>
 - Parameters
 - value: T
 Returns Observable<any>
Returns DelayWhenSubscriber

completed

completed: boolean

delayDurationSelector

delayDurationSelector: function

Type declaration

- (value: T): Observable<any>
- Parameters
 - value: T
 Returns Observable<any>

delayNotifierSubscriptions

delayNotifierSubscriptions: Array<Subscription>

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

values

values: Array<T>

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:87
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:76
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:68
Parameters
- innerSub: InnerSubscriber<T, R>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:64
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:56
Parameters
- outerValue: T
- innerValue: any
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

removeSubscription

removeSubscription(subscription: InnerSubscriber<T, R>): T

- Defined in node_modules/rxjs/src/operator/delayWhen.ts:92
Parameters
- subscription: InnerSubscriber<T, R>
Returns T

tryComplete

tryComplete(): void

- Defined in node_modules/rxjs/src/operator/delayWhen.ts:115
Returns void

tryDelay

tryDelay(delayNotifier: Observable<any>, value: T): void

- Defined in node_modules/rxjs/src/operator/delayWhen.ts:107
Parameters
- delayNotifier: Observable<any>
- value: T
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SubscriptionDelayObservable

SubscriptionDelayObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SubscriptionDelayObservable(source: Observable<T>, subscriptionDelay: Observable<any>): SubscriptionDelayObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:127
Parameters
- source: Observable<T>
- subscriptionDelay: Observable<any>
Returns SubscriptionDelayObservable

_isScalar

_isScalar: boolean

operator

operator: Operator<any, T>

source

source: Observable<T>

subscriptionDelay

subscriptionDelay: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): void

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:132
Parameters
- subscriber: Subscriber<T>
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(subscribe?: function): Observable<T>

Inherited from Observable.create
- Defined in node_modules/rxjs/src/Observable.ts:57
Creates a new cold Observable by calling the Observable constructor

Type parameters
- T
Parameters
- Optional subscribe: function
 - - <R>(subscriber: Subscriber<R>): TeardownLogic
 - Type parameters
 - R
 Parameters
 - subscriber: Subscriber<R>
 Returns TeardownLogic
Returns Observable<T>

a new cold observable

SubscriptionDelaySubscriber

SubscriptionDelaySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SubscriptionDelaySubscriber(parent: Subscriber<T>, source: Observable<T>): SubscriptionDelaySubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:143
Parameters
- parent: Subscriber<T>
- source: Observable<T>
Returns SubscriptionDelaySubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

parent

parent: Subscriber<T>

source

source: Observable<T>

sourceSubscribed

sourceSubscribed: boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:158
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:153
Parameters
- err: any
Returns void

_next

_next(unused: any): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/delayWhen.ts:149
Parameters
- unused: any
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

subscribeToSource

subscribeToSource(): void

- Defined in node_modules/rxjs/src/operator/delayWhen.ts:162
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DelayWhenSignature

__call(delayDurationSelector: function, subscriptionDelay?: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/delayWhen.ts:28
Parameters
- delayDurationSelector: function
 - - (value: T): Observable<any>
 - Parameters
 - value: T
 Returns Observable<any>
- Optional subscriptionDelay: Observable<any>
Returns Observable<T>

delayWhen

delayWhen<T>(delayDurationSelector: function, subscriptionDelay?: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/delayWhen.ts:19
Returns an Observable that delays the emission of items from the source Observable by a subscription delay and a delay selector function for each element.

method

delayWhen

owner

Observable

Type parameters
- T
Parameters
- delayDurationSelector: function
 - - (value: T): Observable<any>
 - Parameters
 - value: T
 Returns Observable<any>
- Optional subscriptionDelay: Observable<any>
Returns Observable<T>

an Observable that delays the emissions of the source Observable by the specified timeout or Date.

"node_modules/rxjs/src/operator/dematerialize"

"node_modules/rxjs/src/operator/dematerialize":

DeMaterializeOperator

DeMaterializeOperator:

call

call(subscriber: Subscriber<any>, source: any): any

- Defined in node_modules/rxjs/src/operator/dematerialize.ts:24
Parameters
- subscriber: Subscriber<any>
- source: any
Returns any

DeMaterializeSubscriber

DeMaterializeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new DeMaterializeSubscriber(destination: Subscriber<any>): DeMaterializeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/dematerialize.ts:34
Parameters
- destination: Subscriber<any>
Returns DeMaterializeSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/dematerialize.ts:39
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DematerializeSignature

__call<R>(): Observable<R>

- Defined in node_modules/rxjs/src/operator/dematerialize.ts:19
Type parameters
- R
Returns Observable<R>

dematerialize

dematerialize<T>(): Observable<any>

- Defined in node_modules/rxjs/src/operator/dematerialize.ts:15
Returns an Observable that transforms Notification objects into the items or notifications they represent.

see

Notification

method

dematerialize

owner

Observable

Type parameters
- T
Returns Observable<any>

an Observable that emits items and notifications embedded in Notification objects emitted by the source Observable.

"node_modules/rxjs/src/operator/distinct"

"node_modules/rxjs/src/operator/distinct":

DistinctOperator

DistinctOperator:

constructor

new DistinctOperator(compare: function, flushes: Observable<any>): DistinctOperator

- Defined in node_modules/rxjs/src/operator/distinct.ts:29
Parameters
- compare: function
 - - (x: T, y: T): boolean
 - Parameters
 - x: T
 - y: T
 Returns boolean
- flushes: Observable<any>
Returns DistinctOperator

compare

compare: function

Type declaration

- (x: T, y: T): boolean
- Parameters
  - x: T
  - y: T
  Returns boolean

flushes

flushes: Observable<any>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/distinct.ts:33
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

DistinctSubscriber

DistinctSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new DistinctSubscriber(destination: Subscriber<T>, compare: function, flushes: Observable<any>): DistinctSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/distinct.ts:44
Parameters
- destination: Subscriber<T>
- compare: function
 - - (x: T, y: T): boolean
 - Parameters
 - x: T
 - y: T
 Returns boolean
- flushes: Observable<any>
Returns DistinctSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

values

values: Array<T>

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/distinct.ts:67
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

compare

compare(x: T, y: T): boolean

- Defined in node_modules/rxjs/src/operator/distinct.ts:86
Parameters
- x: T
- y: T
Returns boolean

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:20
Parameters
- innerSub: InnerSubscriber<T, T>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, T>): void

Overwrites OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/operator/distinct.ts:63
Parameters
- error: any
- innerSub: InnerSubscriber<T, T>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/distinct.ts:57
Parameters
- outerValue: T
- innerValue: T
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, T>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DistinctSignature

__call(compare?: function, flushes?: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/distinct.ts:25
Parameters
- Optional compare: function
 - - (x: T, y: T): boolean
 - Parameters
 - x: T
 - y: T
 Returns boolean
- Optional flushes: Observable<any>
Returns Observable<T>

distinct

distinct<T>(compare?: function, flushes?: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/distinct.ts:21
Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items. If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted. If a comparator function is not provided, an equality check is used by default. As the internal HashSet of this operator grows larger and larger, care should be taken in the domain of inputs this operator may see. An optional parameter is also provided such that an Observable can be provided to queue the internal HashSet to flush the values it holds.

method

distinct

owner

Observable

Type parameters
- T
Parameters
- Optional compare: function
 - - (x: T, y: T): boolean
 - Parameters
 - x: T
 - y: T
 Returns boolean
- Optional flushes: Observable<any>
Returns Observable<T>

an Observable that emits items from the source Observable with distinct values.

"node_modules/rxjs/src/operator/distinctKey"

"node_modules/rxjs/src/operator/distinctKey":

DistinctKeySignature

__call(key: string): Observable<T>
__call<K>(key: string, compare: function, flushes?: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/distinctKey.ts:27
Parameters
- key: string
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/distinctKey.ts:28
Type parameters
- K
Parameters
- key: string
- compare: function
 - - (x: K, y: K): boolean
 - Parameters
 - x: K
 - y: K
 Returns boolean
- Optional flushes: Observable<any>
Returns Observable<T>

distinctKey

distinctKey<T>(key: string, compare?: function, flushes?: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/distinctKey.ts:18
Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from previous items, using a property accessed by using the key provided to check if the two items are distinct. If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted. If a comparator function is not provided, an equality check is used by default. As the internal HashSet of this operator grows larger and larger, care should be taken in the domain of inputs this operator may see. An optional parameter is also provided such that an Observable can be provided to queue the internal HashSet to flush the values it holds.

method

distinctKey

owner

Observable

Type parameters
- T
Parameters
- key: string
 
 string key for object property lookup on each item.
- Optional compare: function
 - - (x: T, y: T): boolean
 - Parameters
 - x: T
 - y: T
 Returns boolean
- Optional flushes: Observable<any>
Returns Observable<T>

an Observable that emits items from the source Observable with distinct values.

"node_modules/rxjs/src/operator/distinctUntilChanged"

"node_modules/rxjs/src/operator/distinctUntilChanged":

DistinctUntilChangedOperator

DistinctUntilChangedOperator:

constructor

new DistinctUntilChangedOperator(compare: function, keySelector: function): DistinctUntilChangedOperator

- Defined in node_modules/rxjs/src/operator/distinctUntilChanged.ts:25
Parameters
- compare: function
  - - (x: K, y: K): boolean
    - Parameters
      - x: K
      - y: K
      Returns boolean
- keySelector: function
  - - (x: T): K
    - Parameters
      - x: T
      Returns K
Returns DistinctUntilChangedOperator

compare

compare: function

Type declaration

- (x: K, y: K): boolean
- Parameters
  - x: K
  - y: K
  Returns boolean

keySelector

keySelector: function

Type declaration

- (x: T): K
- Parameters
  - x: T
  Returns K

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/distinctUntilChanged.ts:30
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

DistinctUntilChangedSubscriber

DistinctUntilChangedSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new DistinctUntilChangedSubscriber(destination: Subscriber<T>, compare: function, keySelector: function): DistinctUntilChangedSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/distinctUntilChanged.ts:42
Parameters
- destination: Subscriber<T>
- compare: function
 - - (x: K, y: K): boolean
 - Parameters
 - x: K
 - y: K
 Returns boolean
- keySelector: function
 - - (x: T): K
 - Parameters
 - x: T
 Returns K
Returns DistinctUntilChangedSubscriber

destination

destination: PartialObserver

hasKey

hasKey: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

key

key: K

keySelector

keySelector: function

Type declaration

- (x: T): K
- Parameters
  - x: T
  Returns K

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/distinctUntilChanged.ts:57
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

compare

compare(x: any, y: any): boolean

- Defined in node_modules/rxjs/src/operator/distinctUntilChanged.ts:53
Parameters
- x: any
- y: any
Returns boolean

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DistinctUntilChangedSignature

__call(compare?: function): Observable<T>
__call<K>(compare: function, keySelector: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/distinctUntilChanged.ts:20
Parameters
- Optional compare: function
 - - (x: T, y: T): boolean
 - Parameters
 - x: T
 - y: T
 Returns boolean
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/distinctUntilChanged.ts:21
Type parameters
- K
Parameters
- compare: function
 - - (x: K, y: K): boolean
 - Parameters
 - x: K
 - y: K
 Returns boolean
- keySelector: function
 - - (x: T): K
 - Parameters
 - x: T
 Returns K
Returns Observable<T>

distinctUntilChanged

distinctUntilChanged<T, K>(compare?: function, keySelector?: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/distinctUntilChanged.ts:16
Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item. If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted. If a comparator function is not provided, an equality check is used by default.

method

distinctUntilChanged

owner

Observable

Type parameters
- T
- K
Parameters
- Optional compare: function
 - - (x: K, y: K): boolean
 - Parameters
 - x: K
 - y: K
 Returns boolean
- Optional keySelector: function
 - - (x: T): K
 - Parameters
 - x: T
 Returns K
Returns Observable<T>

an Observable that emits items from the source Observable with distinct values.

"node_modules/rxjs/src/operator/distinctUntilKeyChanged"

"node_modules/rxjs/src/operator/distinctUntilKeyChanged":

DistinctUntilKeyChangedSignature

__call(key: string): Observable<T>
__call<K>(key: string, compare: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/distinctUntilKeyChanged.ts:24
Parameters
- key: string
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/distinctUntilKeyChanged.ts:25
Type parameters
- K
Parameters
- key: string
- compare: function
 - - (x: K, y: K): boolean
 - Parameters
 - x: K
 - y: K
 Returns boolean
Returns Observable<T>

distinctUntilKeyChanged

distinctUntilKeyChanged<T>(key: string, compare?: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/distinctUntilKeyChanged.ts:15
Returns an Observable that emits all items emitted by the source Observable that are distinct by comparison from the previous item, using a property accessed by using the key provided to check if the two items are distinct. If a comparator function is provided, then it will be called for each item to test for whether or not that value should be emitted. If a comparator function is not provided, an equality check is used by default.

method

distinctUntilKeyChanged

owner

Observable

Type parameters
- T
Parameters
- key: string
 
 string key for object property lookup on each item.
- Optional compare: function
 - - (x: T, y: T): boolean
 - Parameters
 - x: T
 - y: T
 Returns boolean
Returns Observable<T>

an Observable that emits items from the source Observable with distinct values based on the key specified.

"node_modules/rxjs/src/operator/do"

"node_modules/rxjs/src/operator/do":

DoOperator

DoOperator:

constructor

new DoOperator(nextOrObserver?: PartialObserver | function, error?: function, complete?: function): DoOperator

- Defined in node_modules/rxjs/src/operator/do.ts:60
Parameters
- Optional nextOrObserver: PartialObserver | function
- Optional error: function
  - - (e: any): void
    - Parameters
      - e: any
      Returns void
- Optional complete: function
  - - (): void
    - Returns void
Returns DoOperator

complete

complete: function

Type declaration

- (): void
- Returns void

error

error: function

Type declaration

- (e: any): void
- Parameters
  - e: any
  Returns void

nextOrObserver

nextOrObserver: PartialObserver | function

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/do.ts:65
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

DoSubscriber

DoSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new DoSubscriber(destination: Subscriber<T>, nextOrObserver?: PartialObserver | function, error?: function, complete?: function): DoSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/do.ts:77
Parameters
- destination: Subscriber<T>
- Optional nextOrObserver: PartialObserver | function
- Optional error: function
 - - (e: any): void
 - Parameters
 - e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns DoSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

safeSubscriber

safeSubscriber: Subscriber<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/do.ts:111
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/do.ts:101
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/do.ts:91
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DoSignature

__call(next: function, error?: function, complete?: function): Observable<T>
__call(observer: PartialObserver): Observable<T>

- Defined in node_modules/rxjs/src/operator/do.ts:55
Parameters
- next: function
 - - (x: T): void
 - Parameters
 - x: T
 Returns void
- Optional error: function
 - - (e: any): void
 - Parameters
 - e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/do.ts:56
Parameters
- observer: PartialObserver
Returns Observable<T>

_do

_do<T>(nextOrObserver?: PartialObserver | function, error?: function, complete?: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/do.ts:49
Perform a side effect for every emission on the source Observable, but return an Observable that is identical to the source.

Intercepts each emission on the source and runs a function, but returns an output which is identical to the source.

Returns a mirrored Observable of the source Observable, but modified so that the provided Observer is called to perform a side effect for every value, error, and completion emitted by the source. Any errors that are thrown in the aforementioned Observer or handlers are safely sent down the error path of the output Observable.

This operator is useful for debugging your Observables for the correct values or performing other side effects.

Note: this is different to a subscribe on the Observable. If the Observable returned by do is not subscribed, the side effects specified by the Observer will never happen. do therefore simply spies on existing execution, it does not trigger an execution to happen like subscribe does.

example

Map every every click to the clientX position of that click, while also logging the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks .do(ev => console.log(ev)) .map(ev => ev.clientX); positions.subscribe(x => console.log(x));

see

map

see

subscribe

method

do

name

do

owner

Observable

Type parameters
- T
Parameters
- Optional nextOrObserver: PartialObserver | function
- Optional error: function
 - - (e: any): void
 - Parameters
 - e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Observable<T>

An Observable identical to the source, but runs the specified Observer or callback(s) for each item.

"node_modules/rxjs/src/operator/elementAt"

"node_modules/rxjs/src/operator/elementAt":

ElementAtOperator

ElementAtOperator:

constructor

new ElementAtOperator(index: number, defaultValue?: T): ElementAtOperator

- Defined in node_modules/rxjs/src/operator/elementAt.ts:26
Parameters
- index: number
- Optional defaultValue: T
Returns ElementAtOperator

defaultValue

defaultValue: T

index

index: number

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/elementAt.ts:34
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

ElementAtSubscriber

ElementAtSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ElementAtSubscriber(destination: Subscriber<T>, index: number, defaultValue?: T): ElementAtSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/elementAt.ts:44
Parameters
- destination: Subscriber<T>
- index: number
- Optional defaultValue: T
Returns ElementAtSubscriber

defaultValue

defaultValue: T

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/elementAt.ts:57
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(x: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/elementAt.ts:50
Parameters
- x: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ElementAtSignature

__call(index: number, defaultValue?: T): Observable<T>

- Defined in node_modules/rxjs/src/operator/elementAt.ts:22
Parameters
- index: number
- Optional defaultValue: T
Returns Observable<T>

elementAt

elementAt<T>(index: number, defaultValue?: T): Observable<T>

- Defined in node_modules/rxjs/src/operator/elementAt.ts:18
Returns an Observable that emits the item at the specified index in the source Observable. If default is given, missing indices will output this value on next; otherwise, outputs error.

throws

{ArgumentOutOfRangeError} When using elementAt(i), it delivers an ArgumentOutOrRangeError to the Observer's error callback if i < 0 or the Observable has completed before emitting the i-th next notification.

method

elementAt

owner

Observable

Type parameters
- T
Parameters
- index: number
 
 the index of the value to be retrieved.
- Optional defaultValue: T
Returns Observable<T>

an Observable that emits a single item, if it is found. Otherwise, will emit the default value if given.

"node_modules/rxjs/src/operator/every"

"node_modules/rxjs/src/operator/every":

EveryOperator

EveryOperator:

constructor

new EveryOperator(predicate: function, thisArg?: any, source?: Observable<T>): EveryOperator

- Defined in node_modules/rxjs/src/operator/every.ts:24
Parameters
- predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional thisArg: any
- Optional source: Observable<T>
Returns EveryOperator

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

source

source: Observable<T>

thisArg

thisArg: any

call

call(observer: Subscriber<boolean>, source: any): any

- Defined in node_modules/rxjs/src/operator/every.ts:30
Parameters
- observer: Subscriber<boolean>
- source: any
Returns any

EverySubscriber

EverySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new EverySubscriber(destination: Observer<boolean>, predicate: function, thisArg: any, source?: Observable<T>): EverySubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/every.ts:41
Parameters
- destination: Observer<boolean>
- predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- thisArg: any
- Optional source: Observable<T>
Returns EverySubscriber

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thisArg

thisArg: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/every.ts:70
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/every.ts:56
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(everyValueMatch: boolean): void

- Defined in node_modules/rxjs/src/operator/every.ts:51
Parameters
- everyValueMatch: boolean
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

EverySignature

__call(predicate: function, thisArg?: any): Observable<boolean>

- Defined in node_modules/rxjs/src/operator/every.ts:20
Parameters
- predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional thisArg: any
Returns Observable<boolean>

every

every<T>(predicate: function, thisArg?: any): Observable<boolean>

- Defined in node_modules/rxjs/src/operator/every.ts:14
Returns an Observable that emits whether or not every item of the source satisfies the condition specified.

method

every

owner

Observable

Type parameters
- T
Parameters
- predicate: function
 
 a function for determining if an item meets a specified condition.
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional thisArg: any
Returns Observable<boolean>

an Observable of booleans that determines if all items of the source Observable meet the condition specified.

"node_modules/rxjs/src/operator/exhaust"

"node_modules/rxjs/src/operator/exhaust":

SwitchFirstOperator

SwitchFirstOperator:

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/exhaust.ts:53
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

SwitchFirstSubscriber

SwitchFirstSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SwitchFirstSubscriber(destination: Subscriber<T>): SwitchFirstSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/exhaust.ts:65
Parameters
- destination: Subscriber<T>
Returns SwitchFirstSubscriber

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

hasSubscription

hasSubscription: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/exhaust.ts:78
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/exhaust.ts:71
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/exhaust.ts:85
Parameters
- innerSub: Subscription
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, T>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:10
Parameters
- outerValue: T
- innerValue: T
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, T>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchFirstSignature

__call(): T

- Defined in node_modules/rxjs/src/operator/exhaust.ts:48
Returns T

exhaust

exhaust<T>(): Observable<T>

- Defined in node_modules/rxjs/src/operator/exhaust.ts:44
Converts a higher-order Observable into a first-order Observable by dropping inner Observables while the previous inner Observable has not yet completed.

Flattens an Observable-of-Observables by dropping the next inner Observables while the current inner is still executing.

exhaust subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable begins emitting the items emitted by that inner Observable. So far, it behaves like mergeAll. However, exhaust ignores every new inner Observable if the previous Observable has not yet completed. Once that one completes, it will accept and flatten the next inner Observable and repeat this process.

example

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var result = higherOrder.exhaust(); result.subscribe(x => console.log(x));

see

combineAll

see

concatAll

see

switch

see

mergeAll

see

exhaustMap

see

zipAll

method

exhaust

owner

Observable

Type parameters
- T
Returns Observable<T>

Returns an Observable that takes a source of Observables and propagates the first observable exclusively until it completes before subscribing to the next.

"node_modules/rxjs/src/operator/exhaustMap"

"node_modules/rxjs/src/operator/exhaustMap":

SwitchFirstMapOperator

SwitchFirstMapOperator:

constructor

new SwitchFirstMapOperator(project: function, resultSelector?: function): SwitchFirstMapOperator

- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:65
Parameters
- project: function
  - - (value: T, index: number): ObservableInput
    - Parameters
      - value: T
      - index: number
      Returns ObservableInput
- Optional resultSelector: function
  - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
    - Parameters
      - outerValue: T
      - innerValue: I
      - outerIndex: number
      - innerIndex: number
      Returns R
Returns SwitchFirstMapOperator

project

project: function

Type declaration

- (value: T, index: number): ObservableInput
- Parameters
  - value: T
  - index: number
  Returns ObservableInput

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:70
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

SwitchFirstMapSubscriber

SwitchFirstMapSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SwitchFirstMapSubscriber(destination: Subscriber<R>, project: function, resultSelector?: function): SwitchFirstMapSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:83
Parameters
- destination: Subscriber<R>
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns SwitchFirstMapSubscriber

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

hasSubscription

hasSubscription: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

project

project: function

Type declaration

- (value: T, index: number): ObservableInput
- Parameters
  - value: T
  - index: number
  Returns ObservableInput

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:109
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:91
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:142
Parameters
- innerSub: Subscription
Returns void

notifyError

notifyError(err: any): void

Overwrites OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:138
Parameters
- err: any
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:116
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, I>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

tryNext

tryNext(value: T): void

- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:97
Parameters
- value: T
Returns void

trySelectResult

trySelectResult(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:127
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchFirstMapSignature

__call<R>(project: function): Observable<R>
__call<I, R>(project: function, resultSelector: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:59
Type parameters
- R
Parameters
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:60
Type parameters
- I
- R
Parameters
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns Observable<R>

exhaustMap

exhaustMap<T, I, R>(project: function, resultSelector?: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/exhaustMap.ts:54
Projects each source value to an Observable which is merged in the output Observable only if the previous projected Observable has completed.

Maps each value to an Observable, then flattens all of these inner Observables using exhaust.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. When it projects a source value to an Observable, the output Observable begins emitting the items emitted by that projected Observable. However, exhaustMap ignores every new projected Observable if the previous projected Observable has not yet completed. Once that one completes, it will accept and flatten the next projected Observable and repeat this process.

example

Run a finite timer for each click, only if there is no currently active timer var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.exhaustMap((ev) => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

see

concatMap

see

exhaust

see

mergeMap

see

switchMap

method

exhaustMap

owner

Observable

Type parameters
- T
- I
- R
Parameters
- project: function
 
 A function that, when applied to an item emitted by the source Observable, returns an Observable.
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns Observable<R>

An Observable containing projected Observables of each item of the source, ignoring projected Observables that start before their preceding Observable has completed.

"node_modules/rxjs/src/operator/expand"

"node_modules/rxjs/src/operator/expand":

ExpandOperator

ExpandOperator:

constructor

new ExpandOperator(project: function, concurrent: number, scheduler: Scheduler): ExpandOperator

- Defined in node_modules/rxjs/src/operator/expand.ts:35
Parameters
- project: function
 - - (value: T, index: number): Observable<R>
 - Parameters
 - value: T
 - index: number
 Returns Observable<R>
- concurrent: number
- scheduler: Scheduler
Returns ExpandOperator

concurrent

concurrent: number

project

project: function

Type declaration

- (value: T, index: number): Observable<R>
- Parameters
 - value: T
 - index: number
 Returns Observable<R>

scheduler

scheduler: Scheduler

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/expand.ts:41
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

ExpandSubscriber

ExpandSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ExpandSubscriber(destination: Subscriber<R>, project: function, concurrent: number, scheduler: Scheduler): ExpandSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/expand.ts:62
Parameters
- destination: Subscriber<R>
- project: function
 - - (value: T, index: number): Observable<R>
 - Parameters
 - value: T
 - index: number
 Returns Observable<R>
- concurrent: number
- scheduler: Scheduler
Returns ExpandSubscriber

active

active: number

buffer

buffer: any[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

project

project: function

Type declaration

- (value: T, index: number): Observable<R>
- Parameters
 - value: T
 - index: number
 Returns Observable<R>

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/expand.ts:109
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: any): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/expand.ts:79
Parameters
- value: any
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/expand.ts:122
Parameters
- innerSub: Subscription
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/expand.ts:116
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

subscribeToProjection

subscribeToProjection(result: any, value: T, index: number): void

- Defined in node_modules/rxjs/src/operator/expand.ts:104
Parameters
- result: any
- value: T
- index: number
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatch

dispatch<T, R>(arg: DispatchArg<T, R>): void

- Defined in node_modules/rxjs/src/operator/expand.ts:74
Type parameters
- T
- R
Parameters
- arg: DispatchArg<T, R>
Returns void

DispatchArg

DispatchArg:

index

index: number

result

result: Observable<R>

subscriber

subscriber: ExpandSubscriber<T, R>

value

value: any

ExpandSignature

__call(project: function, concurrent?: number, scheduler?: Scheduler): Observable<T>
__call<R>(project: function, concurrent?: number, scheduler?: Scheduler): Observable<R>

- Defined in node_modules/rxjs/src/operator/expand.ts:30
Parameters
- project: function
 - - (value: T, index: number): Observable<T>
 - Parameters
 - value: T
 - index: number
 Returns Observable<T>
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/expand.ts:31
Type parameters
- R
Parameters
- project: function
 - - (value: T, index: number): Observable<R>
 - Parameters
 - value: T
 - index: number
 Returns Observable<R>
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<R>

expand

expand<T, R>(project: function, concurrent?: number, scheduler?: Scheduler): Observable<R>

- Defined in node_modules/rxjs/src/operator/expand.ts:22
Returns an Observable where for each item in the source Observable, the supplied function is applied to each item, resulting in a new value to then be applied again with the function.

method

expand

owner

Observable

Type parameters
- T
- R
Parameters
- project: function
 
 the function for projecting the next emitted item of the Observable.
 - - (value: T, index: number): Observable<R>
 - Parameters
 - value: T
 - index: number
 Returns Observable<R>
- Default value concurrent: number = Number.POSITIVE_INFINITY
- Default value scheduler: Scheduler = undefined
Returns Observable<R>

an Observable containing the expansions of the source Observable.

"node_modules/rxjs/src/operator/filter"

"node_modules/rxjs/src/operator/filter":

FilterOperator

FilterOperator:

constructor

new FilterOperator(predicate: function, thisArg?: any): FilterOperator

- Defined in node_modules/rxjs/src/operator/filter.ts:54
Parameters
- predicate: function
  - - (value: T, index: number): boolean
    - Parameters
      - value: T
      - index: number
      Returns boolean
- Optional thisArg: any
Returns FilterOperator

predicate

predicate: function

Type declaration

- (value: T, index: number): boolean
- Parameters
  - value: T
  - index: number
  Returns boolean

thisArg

thisArg: any

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/filter.ts:59
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

FilterSubscriber

FilterSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new FilterSubscriber(destination: Subscriber<T>, predicate: function, thisArg: any): FilterSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/filter.ts:71
Parameters
- destination: Subscriber<T>
- predicate: function
 - - (value: T, index: number): boolean
 - Parameters
 - value: T
 - index: number
 Returns boolean
- thisArg: any
Returns FilterSubscriber

count

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

predicate

predicate: function

Type declaration

- (value: T, index: number): boolean
- Parameters
  - value: T
  - index: number
  Returns boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thisArg

thisArg: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/filter.ts:82
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

FilterSignature

__call(predicate: function, thisArg?: any): Observable<T>

- Defined in node_modules/rxjs/src/operator/filter.ts:50
Parameters
- predicate: function
 - - (value: T, index: number): boolean
 - Parameters
 - value: T
 - index: number
 Returns boolean
- Optional thisArg: any
Returns Observable<T>

filter

filter<T>(predicate: function, thisArg?: any): Observable<T>

- Defined in node_modules/rxjs/src/operator/filter.ts:45
Filter items emitted by the source Observable by only emitting those that satisfy a specified predicate.

Like Array.prototype.filter(), it only emits a value from the source if it passes a criterion function.

Similar to the well-known Array.prototype.filter method, this operator takes values from the source Observable, passes them through a predicate function and only emits those values that yielded true.

example

Emit only click events whose target was a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var clicksOnDivs = clicks.filter(ev => ev.target.tagName === 'DIV'); clicksOnDivs.subscribe(x => console.log(x));

see

distinct

see

distinctKey

see

distinctUntilChanged

see

distinctUntilKeyChanged

see

ignoreElements

see

partition

see

skip

method

filter

owner

Observable

Type parameters
- T
Parameters
- predicate: function
 
 A function that evaluates each value emitted by the source Observable. If it returns true, the value is emitted, if false the value is not passed to the output Observable. The index parameter is the number i for the i-th source emission that has happened since the subscription, starting from the number 0.
 - - (value: T, index: number): boolean
 - Parameters
 - value: T
 - index: number
 Returns boolean
- Optional thisArg: any
Returns Observable<T>

An Observable of values from the source that were allowed by the predicate function.

"node_modules/rxjs/src/operator/finally"

"node_modules/rxjs/src/operator/finally":

FinallyOperator

FinallyOperator:

constructor

new FinallyOperator(finallySelector: function): FinallyOperator

- Defined in node_modules/rxjs/src/operator/finally.ts:22
Parameters
- finallySelector: function
  - - (): void
    - Returns void
Returns FinallyOperator

finallySelector

finallySelector: function

Type declaration

- (): void
- Returns void

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/finally.ts:26
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

FinallySubscriber

FinallySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new FinallySubscriber(destination: Subscriber<T>, finallySelector: function): FinallySubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/finally.ts:36
Parameters
- destination: Subscriber<T>
- finallySelector: function
 - - (): void
 - Returns void
Returns FinallySubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

FinallySignature

__call<T>(finallySelector: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/finally.ts:18
Type parameters
- T
Parameters
- finallySelector: function
 - - (): void
 - Returns void
Returns Observable<T>

_finally

_finally<T>(finallySelector: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/finally.ts:14
Returns an Observable that mirrors the source Observable, but will call a specified function when the source terminates on complete or error.

method

finally

owner

Observable

Type parameters
- T
Parameters
- finallySelector: function
 
 function to be called when source terminates.
 - - (): void
 - Returns void
Returns Observable<T>

an Observable that mirrors the source, but will call the specified function on termination.

"node_modules/rxjs/src/operator/find"

"node_modules/rxjs/src/operator/find":

FindValueOperator

FindValueOperator:

constructor

new FindValueOperator(predicate: function, source: Observable<T>, yieldIndex: boolean, thisArg?: any): FindValueOperator

- Defined in node_modules/rxjs/src/operator/find.ts:50
Parameters
- predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- source: Observable<T>
- yieldIndex: boolean
- Optional thisArg: any
Returns FindValueOperator

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

source

source: Observable<T>

thisArg

thisArg: any

yieldIndex

yieldIndex: boolean

call

call(observer: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/find.ts:57
Parameters
- observer: Subscriber<T>
- source: any
Returns any

FindValueSubscriber

FindValueSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new FindValueSubscriber(destination: Subscriber<T>, predicate: function, source: Observable<T>, yieldIndex: boolean, thisArg?: any): FindValueSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/find.ts:68
Parameters
- destination: Subscriber<T>
- predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- source: Observable<T>
- yieldIndex: boolean
- Optional thisArg: any
Returns FindValueSubscriber

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thisArg

thisArg: any

yieldIndex

yieldIndex: boolean

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/find.ts:98
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/find.ts:85
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(value: any): void

- Defined in node_modules/rxjs/src/operator/find.ts:78
Parameters
- value: any
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

FindSignature

__call(predicate: function, thisArg?: any): Observable<T>

- Defined in node_modules/rxjs/src/operator/find.ts:46
Parameters
- predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional thisArg: any
Returns Observable<T>

find

find<T>(predicate: function, thisArg?: any): Observable<T>

- Defined in node_modules/rxjs/src/operator/find.ts:38
Emits only the first value emitted by the source Observable that meets some condition.

Finds the first value that passes some test and emits that.

find searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the first occurrence in the source. Unlike first, the predicate is required in find, and does not emit an error if a valid value is not found.

example

Find and emit the first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.find(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

see

filter

see

first

see

findIndex

see

take

method

find

owner

Observable

Type parameters
- T
Parameters
- predicate: function
 
 A function called with each item to test for condition matching.
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional thisArg: any
Returns Observable<T>

An Observable of the first item that matches the condition.

"node_modules/rxjs/src/operator/findIndex"

"node_modules/rxjs/src/operator/findIndex":

FindIndexSignature

__call(predicate: function, thisArg?: any): Observable<number>

- Defined in node_modules/rxjs/src/operator/findIndex.ts:43
Parameters
- predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional thisArg: any
Returns Observable<number>

findIndex

findIndex<T>(predicate: function, thisArg?: any): Observable<number>

- Defined in node_modules/rxjs/src/operator/findIndex.ts:38
Emits only the index of the first value emitted by the source Observable that meets some condition.

It's like find, but emits the index of the found value, not the value itself.

findIndex searches for the first item in the source Observable that matches the specified condition embodied by the predicate, and returns the (zero-based) index of the first occurrence in the source. Unlike first, the predicate is required in findIndex, and does not emit an error if a valid value is not found.

example

Emit the index of first click that happens on a DIV element var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.findIndex(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

see

filter

see

find

see

first

see

take

method

find

owner

Observable

Type parameters
- T
Parameters
- predicate: function
 
 A function called with each item to test for condition matching.
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional thisArg: any
Returns Observable<number>

An Observable of the index of the first item that matches the condition.

"node_modules/rxjs/src/operator/first"

"node_modules/rxjs/src/operator/first":

FirstOperator

FirstOperator:

constructor

new FirstOperator(predicate?: function, resultSelector?: function, defaultValue?: any, source?: Observable<T>): FirstOperator

- Defined in node_modules/rxjs/src/operator/first.ts:68
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional resultSelector: function
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- Optional defaultValue: any
- Optional source: Observable<T>
Returns FirstOperator

defaultValue

defaultValue: any

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

resultSelector

resultSelector: function

Type declaration

- (value: T, index: number): R
- Parameters
  - value: T
  - index: number
  Returns R

source

source: Observable<T>

call

call(observer: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/first.ts:75
Parameters
- observer: Subscriber<R>
- source: any
Returns any

FirstSubscriber

FirstSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new FirstSubscriber(destination: Subscriber<R>, predicate?: function, resultSelector?: function, defaultValue?: any, source?: Observable<T>): FirstSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/first.ts:87
Parameters
- destination: Subscriber<R>
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional resultSelector: function
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- Optional defaultValue: any
- Optional source: Observable<T>
Returns FirstSubscriber

defaultValue

defaultValue: any

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

resultSelector

resultSelector: function

Type declaration

- (value: T, index: number): R
- Parameters
  - value: T
  - index: number
  Returns R

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/first.ts:145
Returns void

_emit

_emit(value: any, index: number): void

- Defined in node_modules/rxjs/src/operator/first.ts:119
Parameters
- value: any
- index: number
Returns void

_emitFinal

_emitFinal(value: any): void

- Defined in node_modules/rxjs/src/operator/first.ts:138
Parameters
- value: any
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/first.ts:97
Parameters
- value: T
Returns void

_tryPredicate

_tryPredicate(value: T, index: number): void

- Defined in node_modules/rxjs/src/operator/first.ts:106
Parameters
- value: T
- index: number
Returns void

_tryResultSelector

_tryResultSelector(value: T, index: number): void

- Defined in node_modules/rxjs/src/operator/first.ts:127
Parameters
- value: T
- index: number
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

FirstSignature

__call(predicate?: function): Observable<T>
__call(predicate: function, resultSelector: void, defaultValue?: T): Observable<T>
__call<R>(predicate?: function, resultSelector?: function, defaultValue?: R): Observable<R>

- Defined in node_modules/rxjs/src/operator/first.ts:61
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/first.ts:62
Parameters
- predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- resultSelector: void
- Optional defaultValue: T
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/first.ts:63
Type parameters
- R
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional resultSelector: function
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- Optional defaultValue: R
Returns Observable<R>

first

first<T, R>(predicate?: function, resultSelector?: function, defaultValue?: R): Observable<T | R>

- Defined in node_modules/rxjs/src/operator/first.ts:55
Emits only the first value (or the first value that meets some condition) emitted by the source Observable.

Emits only the first value. Or emits only the first value that passes some test.

If called with no arguments, first emits the first value of the source Observable, then completes. If called with a predicate function, first emits the first value of the source that matches the specified condition. It may also take a resultSelector function to produce the output value from the input value, and a defaultValue to emit in case the source completes before it is able to emit a valid value. Throws an error if defaultValue was not provided and a matching element is not found.

example

Emit only the first click that happens on the DOM var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(); result.subscribe(x => console.log(x));

example

Emits the first click that happens on a DIV var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.first(ev => ev.target.tagName === 'DIV'); result.subscribe(x => console.log(x));

see

filter

see

find

see

take

throws

{EmptyError} Delivers an EmptyError to the Observer's error callback if the Observable completes before any next notification was sent.

method

first

owner

Observable

Type parameters
- T
- R
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional resultSelector: function
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- Optional defaultValue: R
Returns Observable<T | R>

an Observable of the first item that matches the condition.

"node_modules/rxjs/src/operator/groupBy"

"node_modules/rxjs/src/operator/groupBy":

GroupByOperator

GroupByOperator:

constructor

new GroupByOperator(source: Observable<T>, keySelector: function, elementSelector?: function, durationSelector?: function): GroupByOperator

- Defined in node_modules/rxjs/src/operator/groupBy.ts:51
Parameters
- source: Observable<T>
- keySelector: function
 - - (value: T): K
 - Parameters
 - value: T
 Returns K
- Optional elementSelector: function
 - - (value: T): R
 - Parameters
 - value: T
 Returns R
- Optional durationSelector: function
 - - (grouped: GroupedObservable<K, R>): Observable<any>
 - Parameters
 - grouped: GroupedObservable<K, R>
 Returns Observable<any>
Returns GroupByOperator

durationSelector

durationSelector: function

Type declaration

- (grouped: GroupedObservable<K, R>): Observable<any>
- Parameters
 - grouped: GroupedObservable<K, R>
 Returns Observable<any>

elementSelector

elementSelector: function

Type declaration

- (value: T): R
- Parameters
  - value: T
  Returns R

keySelector

keySelector: function

Type declaration

- (value: T): K
- Parameters
  - value: T
  Returns K

source

source: Observable<T>

call

call(subscriber: Subscriber<GroupedObservable<K, R>>, source: any): any

- Defined in node_modules/rxjs/src/operator/groupBy.ts:58
Parameters
- subscriber: Subscriber<GroupedObservable<K, R>>
- source: any
Returns any

GroupBySubscriber

GroupBySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new GroupBySubscriber(destination: Subscriber<GroupedObservable<K, R>>, keySelector: function, elementSelector?: function, durationSelector?: function): GroupBySubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/groupBy.ts:73
Parameters
- destination: Subscriber<GroupedObservable<K, R>>
- keySelector: function
 - - (value: T): K
 - Parameters
 - value: T
 Returns K
- Optional elementSelector: function
 - - (value: T): R
 - Parameters
 - value: T
 Returns R
- Optional durationSelector: function
 - - (grouped: GroupedObservable<K, R>): Observable<any>
 - Parameters
 - grouped: GroupedObservable<K, R>
 Returns Observable<any>
Returns GroupBySubscriber

attemptedToUnsubscribe

attemptedToUnsubscribe: boolean

count

destination

destination: PartialObserver

durationSelector

durationSelector: function

Type declaration

- (grouped: GroupedObservable<K, R>): Observable<any>
- Parameters
 - grouped: GroupedObservable<K, R>
 Returns Observable<any>

elementSelector

elementSelector: function

Type declaration

- (value: T): R
- Parameters
  - value: T
  Returns R

groups

groups: Map<K, Subject<T | R>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

keySelector

keySelector: function

Type declaration

- (value: T): K
- Parameters
  - value: T
  Returns K

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/groupBy.ts:163
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/groupBy.ts:151
Parameters
- err: any
Returns void

_group

_group(value: T, key: K): void

- Defined in node_modules/rxjs/src/operator/groupBy.ts:96
Parameters
- value: T
- key: K
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/groupBy.ts:84
Parameters
- value: T
Returns void

_selectDuration

_selectDuration(key: K, group: any): void

- Defined in node_modules/rxjs/src/operator/groupBy.ts:134
Parameters
- key: K
- group: any
Returns void

_selectElement

_selectElement(value: T, group: Subject<T | R>): void

- Defined in node_modules/rxjs/src/operator/groupBy.ts:123
Parameters
- value: T
- group: Subject<T | R>
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

removeGroup

removeGroup(key: K): void

- Defined in node_modules/rxjs/src/operator/groupBy.ts:175
Parameters
- key: K
Returns void

tryGroupNext

tryGroupNext(value: T | R, group: Subject<T | R>): void

- Defined in node_modules/rxjs/src/operator/groupBy.ts:145
Parameters
- value: T | R
- group: Subject<T | R>
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Overwrites Subscriber.unsubscribe
- Defined in node_modules/rxjs/src/operator/groupBy.ts:179
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

GroupDurationSubscriber

GroupDurationSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new GroupDurationSubscriber(key: K, group: Subject<T>, parent: GroupBySubscriber<any, K, T>): GroupDurationSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/groupBy.ts:194
Parameters
- key: K
- group: Subject<T>
- parent: GroupBySubscriber<any, K, T>
Returns GroupDurationSubscriber

destination

destination: PartialObserver

group

group: Subject<T>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

key

key: K

parent

parent: GroupBySubscriber<any, K, T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/groupBy.ts:209
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/groupBy.ts:205
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/groupBy.ts:201
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

tryComplete

tryComplete(): void

- Defined in node_modules/rxjs/src/operator/groupBy.ts:221
Returns void

tryError

tryError(err: any): void

- Defined in node_modules/rxjs/src/operator/groupBy.ts:213
Parameters
- err: any
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

GroupedObservable

GroupedObservable:

An Observable representing values belonging to the same group represented by a common key. The values emitted by a GroupedObservable come from the source Observable. The common key is available as the field key on a GroupedObservable instance.

class: GroupedObservable

constructor

new GroupedObservable(key: K, groupSubject: Subject<T>, refCountSubscription?: RefCountSubscription): GroupedObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/operator/groupBy.ts:238
Parameters
- key: K
- groupSubject: Subject<T>
- Optional refCountSubscription: RefCountSubscription
Returns GroupedObservable

_isScalar

_isScalar: boolean

groupSubject

groupSubject: Subject<T>

key

key: K

operator

operator: Operator<any, T>

refCountSubscription

refCountSubscription: RefCountSubscription

source

source: Observable<any>

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<T>): Subscription

Overwrites Observable._subscribe
- Defined in node_modules/rxjs/src/operator/groupBy.ts:245
Parameters
- subscriber: Subscriber<T>
Returns Subscription

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(subscribe?: function): Observable<T>

Inherited from Observable.create
- Defined in node_modules/rxjs/src/Observable.ts:57
Creates a new cold Observable by calling the Observable constructor

Type parameters
- T
Parameters
- Optional subscribe: function
 - - <R>(subscriber: Subscriber<R>): TeardownLogic
 - Type parameters
 - R
 Parameters
 - subscriber: Subscriber<R>
 Returns TeardownLogic
Returns Observable<T>

a new cold observable

InnerRefCountSubscription

InnerRefCountSubscription:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new InnerRefCountSubscription(parent: RefCountSubscription): InnerRefCountSubscription

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/operator/groupBy.ts:261
Parameters
- parent: RefCountSubscription
Returns InnerRefCountSubscription

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

parent

parent: RefCountSubscription

EMPTY

EMPTY: Subscription

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/operator/groupBy.ts:267
Returns void

GroupBySignature

__call<K>(keySelector: function): Observable<GroupedObservable<K, T>>
__call<K>(keySelector: function, elementSelector: void, durationSelector: function): Observable<GroupedObservable<K, T>>
__call<K, R>(keySelector: function, elementSelector?: function, durationSelector?: function): Observable<GroupedObservable<K, R>>

- Defined in node_modules/rxjs/src/operator/groupBy.ts:37
Type parameters
- K
Parameters
- keySelector: function
 - - (value: T): K
 - Parameters
 - value: T
 Returns K
Returns Observable<GroupedObservable<K, T>>
- Defined in node_modules/rxjs/src/operator/groupBy.ts:38
Type parameters
- K
Parameters
- keySelector: function
 - - (value: T): K
 - Parameters
 - value: T
 Returns K
- elementSelector: void
- durationSelector: function
 - - (grouped: GroupedObservable<K, T>): Observable<any>
 - Parameters
 - grouped: GroupedObservable<K, T>
 Returns Observable<any>
Returns Observable<GroupedObservable<K, T>>
- Defined in node_modules/rxjs/src/operator/groupBy.ts:39
Type parameters
- K
- R
Parameters
- keySelector: function
 - - (value: T): K
 - Parameters
 - value: T
 Returns K
- Optional elementSelector: function
 - - (value: T): R
 - Parameters
 - value: T
 Returns R
- Optional durationSelector: function
 - - (grouped: GroupedObservable<K, R>): Observable<any>
 - Parameters
 - grouped: GroupedObservable<K, R>
 Returns Observable<any>
Returns Observable<GroupedObservable<K, R>>

RefCountSubscription

RefCountSubscription:

attemptedToUnsubscribe

attemptedToUnsubscribe: boolean

count

isUnsubscribed

isUnsubscribed: boolean

unsubscribe

unsubscribe: function

Type declaration

- (): void
- Returns void

groupBy

groupBy<T, K, R>(keySelector: function, elementSelector?: function, durationSelector?: function): Observable<GroupedObservable<K, R>>

- Defined in node_modules/rxjs/src/operator/groupBy.ts:30
Groups the items emitted by an Observable according to a specified criterion, and emits these grouped items as GroupedObservables, one GroupedObservable per group.

method

groupBy

owner

Observable

Type parameters
- T
- K
- R
Parameters
- keySelector: function
 
 a function that extracts the key for each item.
 - - (value: T): K
 - Parameters
 - value: T
 Returns K
- Optional elementSelector: function
 - - (value: T): R
 - Parameters
 - value: T
 Returns R
- Optional durationSelector: function
 - - (grouped: GroupedObservable<K, R>): Observable<any>
 - Parameters
 - grouped: GroupedObservable<K, R>
 Returns Observable<any>
Returns Observable<GroupedObservable<K, R>>

an Observable that emits GroupedObservables, each of which corresponds to a unique key value and each of which emits those items from the source Observable that share that key value.

"node_modules/rxjs/src/operator/ignoreElements"

"node_modules/rxjs/src/operator/ignoreElements":

IgnoreElementsOperator

IgnoreElementsOperator:

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/ignoreElements.ts:25
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

IgnoreElementsSubscriber

IgnoreElementsSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new IgnoreElementsSubscriber(destinationOrNext?: PartialObserver | function, error?: function, complete?: function): IgnoreElementsSubscriber

Inherited from Subscriber.constructor

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/Subscriber.ts:43
Parameters
- Optional destinationOrNext: PartialObserver | function
- Optional error: function
  - - (e?: any): void
    - Parameters
      - Optional e: any
      Returns void
- Optional complete: function
  - - (): void
    - Returns void
Returns IgnoreElementsSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(unused: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/ignoreElements.ts:36
Parameters
- unused: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

IgnoreElementsSignature

__call(): Observable<T>

- Defined in node_modules/rxjs/src/operator/ignoreElements.ts:20
Returns Observable<T>

ignoreElements

ignoreElements<T>(): Observable<T>

- Defined in node_modules/rxjs/src/operator/ignoreElements.ts:16
Ignores all items emitted by the source Observable and only passes calls of complete or error.

method

ignoreElements

owner

Observable

Type parameters
- T
Returns Observable<T>

an empty Observable that only calls complete or error, based on which one is called by the source Observable.

"node_modules/rxjs/src/operator/isEmpty"

"node_modules/rxjs/src/operator/isEmpty":

IsEmptyOperator

IsEmptyOperator:

call

call(observer: Subscriber<boolean>, source: any): any

- Defined in node_modules/rxjs/src/operator/isEmpty.ts:23
Parameters
- observer: Subscriber<boolean>
- source: any
Returns any

IsEmptySubscriber

IsEmptySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new IsEmptySubscriber(destination: Subscriber<boolean>): IsEmptySubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/isEmpty.ts:33
Parameters
- destination: Subscriber<boolean>
Returns IsEmptySubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/isEmpty.ts:49
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: boolean): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/isEmpty.ts:45
Parameters
- value: boolean
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: any): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: any
Returns void

notifyComplete

notifyComplete(isEmpty: boolean): void

- Defined in node_modules/rxjs/src/operator/isEmpty.ts:38
Parameters
- isEmpty: boolean
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

IsEmptySignature

__call(): Observable<boolean>

- Defined in node_modules/rxjs/src/operator/isEmpty.ts:18
Returns Observable<boolean>

isEmpty

isEmpty(): Observable<boolean>

- Defined in node_modules/rxjs/src/operator/isEmpty.ts:14
If the source Observable is empty it returns an Observable that emits true, otherwise it emits false.

method

isEmpty

owner

Observable

Returns Observable<boolean>

an Observable that emits a Boolean.

"node_modules/rxjs/src/operator/last"

"node_modules/rxjs/src/operator/last":

LastOperator

LastOperator:

constructor

new LastOperator(predicate?: function, resultSelector?: function, defaultValue?: any, source?: Observable<T>): LastOperator

- Defined in node_modules/rxjs/src/operator/last.ts:36
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional resultSelector: function
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- Optional defaultValue: any
- Optional source: Observable<T>
Returns LastOperator

defaultValue

defaultValue: any

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

resultSelector

resultSelector: function

Type declaration

- (value: T, index: number): R
- Parameters
  - value: T
  - index: number
  Returns R

source

source: Observable<T>

call

call(observer: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/last.ts:43
Parameters
- observer: Subscriber<R>
- source: any
Returns any

LastSubscriber

LastSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new LastSubscriber(destination: Subscriber<R>, predicate?: function, resultSelector?: function, defaultValue?: any, source?: Observable<T>): LastSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/last.ts:56
Parameters
- destination: Subscriber<R>
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional resultSelector: function
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- Optional defaultValue: any
- Optional source: Observable<T>
Returns LastSubscriber

defaultValue

defaultValue: any

destination

destination: PartialObserver

hasValue

hasValue: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

lastValue

lastValue: T | R

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

resultSelector

resultSelector: function

Type declaration

- (value: T, index: number): R
- Parameters
  - value: T
  - index: number
  Returns R

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/last.ts:114
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/last.ts:70
Parameters
- value: T
Returns void

_tryPredicate

_tryPredicate(value: T, index: number): void

- Defined in node_modules/rxjs/src/operator/last.ts:84
Parameters
- value: T
- index: number
Returns void

_tryResultSelector

_tryResultSelector(value: T, index: number): void

- Defined in node_modules/rxjs/src/operator/last.ts:102
Parameters
- value: T
- index: number
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

LastSignature

__call(predicate?: function): Observable<T>
__call(predicate: function, resultSelector: void, defaultValue?: T): Observable<T>
__call<R>(predicate?: function, resultSelector?: function, defaultValue?: R): Observable<R>

- Defined in node_modules/rxjs/src/operator/last.ts:29
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/last.ts:30
Parameters
- predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- resultSelector: void
- Optional defaultValue: T
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/last.ts:31
Type parameters
- R
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional resultSelector: function
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- Optional defaultValue: R
Returns Observable<R>

last

last<T, R>(predicate?: function, resultSelector?: function, defaultValue?: R): Observable<T | R>

- Defined in node_modules/rxjs/src/operator/last.ts:23
Returns an Observable that emits only the last item emitted by the source Observable. It optionally takes a predicate function as a parameter, in which case, rather than emitting the last item from the source Observable, the resulting Observable will emit the last item from the source Observable that satisfies the predicate.
throws

{EmptyError} Delivers an EmptyError to the Observer's error callback if the Observable completes before any next notification was sent.

throws
- Throws if no items that match the predicate are emitted by the source Observable.
method

last

owner

Observable
Type parameters
- T
- R
Parameters
- Optional predicate: function
 
 the condition any source emitted item has to satisfy.
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional resultSelector: function
 - - (value: T, index: number): R | void
 - Parameters
 - value: T
 - index: number
 Returns R | void
- Optional defaultValue: R
Returns Observable<T | R>

an Observable that emits only the last item satisfying the given condition from the source, or an NoSuchElementException if no such items are emitted.

"node_modules/rxjs/src/operator/let"

"node_modules/rxjs/src/operator/let":

LetSignature

__call<R>(func: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/let.ts:13
Type parameters
- R
Parameters
- func: function
 - - (selector: Observable<T>): Observable<R>
 - Parameters
 - selector: Observable<T>
 Returns Observable<R>
Returns Observable<R>

letProto

letProto<T, R>(func: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/let.ts:9
method

let

owner

Observable

Type parameters
- T
- R
Parameters
- func: function
 - - (selector: Observable<T>): Observable<R>
 - Parameters
 - selector: Observable<T>
 Returns Observable<R>
Returns Observable<R>

"node_modules/rxjs/src/operator/map"

"node_modules/rxjs/src/operator/map":

MapOperator

MapOperator:

constructor

new MapOperator(project: function, thisArg: any): MapOperator

- Defined in node_modules/rxjs/src/operator/map.ts:49
Parameters
- project: function
  - - (value: T, index: number): R
    - Parameters
      - value: T
      - index: number
      Returns R
- thisArg: any
Returns MapOperator

project

project: function

Type declaration

- (value: T, index: number): R
- Parameters
  - value: T
  - index: number
  Returns R

thisArg

thisArg: any

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/map.ts:53
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

MapSubscriber

MapSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new MapSubscriber(destination: Subscriber<R>, project: function, thisArg: any): MapSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/map.ts:65
Parameters
- destination: Subscriber<R>
- project: function
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- thisArg: any
Returns MapSubscriber

count

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

project

project: function

Type declaration

- (value: T, index: number): R
- Parameters
  - value: T
  - index: number
  Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

thisArg

thisArg: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/map.ts:76
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MapSignature

__call<R>(project: function, thisArg?: any): Observable<R>

- Defined in node_modules/rxjs/src/operator/map.ts:45
Type parameters
- R
Parameters
- project: function
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- Optional thisArg: any
Returns Observable<R>

map

map<T, R>(project: function, thisArg?: any): Observable<R>

- Defined in node_modules/rxjs/src/operator/map.ts:38
Applies a given project function to each value emitted by the source Observable, and emits the resulting values as an Observable.

Like Array.prototype.map(), it passes each source value through a transformation function to get corresponding output values.

Similar to the well known Array.prototype.map function, this operator applies a projection to each value and emits that projection in the output Observable.

example

Map every every click to the clientX position of that click var clicks = Rx.Observable.fromEvent(document, 'click'); var positions = clicks.map(ev => ev.clientX); positions.subscribe(x => console.log(x));

see

mapTo

see

pluck

method

map

owner

Observable

Type parameters
- T
- R
Parameters
- project: function
 
 The function to apply to each value emitted by the source Observable. The index parameter is the number i for the i-th emission that has happened since the subscription, starting from the number 0.
 - - (value: T, index: number): R
 - Parameters
 - value: T
 - index: number
 Returns R
- Optional thisArg: any
Returns Observable<R>

An Observable that emits the values from the source Observable transformed by the given project function.

"node_modules/rxjs/src/operator/mapTo"

"node_modules/rxjs/src/operator/mapTo":

MapToOperator

MapToOperator:

constructor

new MapToOperator(value: R): MapToOperator

- Defined in node_modules/rxjs/src/operator/mapTo.ts:41
Parameters
- value: R
Returns MapToOperator

value

value: R

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/mapTo.ts:47
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

MapToSubscriber

MapToSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new MapToSubscriber(destination: Subscriber<R>, value: R): MapToSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/mapTo.ts:59
Parameters
- destination: Subscriber<R>
- value: R
Returns MapToSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

value

value: R

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(x: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/mapTo.ts:66
Parameters
- x: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MapToSignature

__call<R>(value: R): Observable<R>

- Defined in node_modules/rxjs/src/operator/mapTo.ts:35
Type parameters
- R
Parameters
- value: R
Returns Observable<R>

mapTo

mapTo<T, R>(value: R): Observable<R>

- Defined in node_modules/rxjs/src/operator/mapTo.ts:31
Emits the given constant value on the output Observable every time the source Observable emits a value.

Like map, but it maps every source value to the same output value every time.

Takes a constant value as argument, and emits that whenever the source Observable emits a value. In other words, ignores the actual source value, and simply uses the emission moment to know when to emit the given value.

example

Map every every click to the string 'Hi' var clicks = Rx.Observable.fromEvent(document, 'click'); var greetings = clicks.mapTo('Hi'); greetings.subscribe(x => console.log(x));

see

map

method

mapTo

owner

Observable

Type parameters
- T
- R
Parameters
- value: R
 
 The value to map each source value to.
Returns Observable<R>

An Observable that emits the given value every time the source Observable emits something.

"node_modules/rxjs/src/operator/materialize"

"node_modules/rxjs/src/operator/materialize":

MaterializeOperator

MaterializeOperator:

call

call(subscriber: Subscriber<Notification<T>>, source: any): any

- Defined in node_modules/rxjs/src/operator/materialize.ts:30
Parameters
- subscriber: Subscriber<Notification<T>>
- source: any
Returns any

MaterializeSubscriber

MaterializeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new MaterializeSubscriber(destination: Subscriber<Notification<T>>): MaterializeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/materialize.ts:40
Parameters
- destination: Subscriber<Notification<T>>
Returns MaterializeSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/materialize.ts:55
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/materialize.ts:49
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/materialize.ts:45
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MaterializeSignature

__call(): Observable<Notification<T>>

- Defined in node_modules/rxjs/src/operator/materialize.ts:25
Returns Observable<Notification<T>>

materialize

materialize<T>(): Observable<Notification<T>>

- Defined in node_modules/rxjs/src/operator/materialize.ts:21
Returns an Observable that represents all of the emissions and notifications from the source Observable into emissions marked with their original types within a Notification objects.

see

Notification

scheduler

materialize does not operate by default on a particular Scheduler.

method

materialize

owner

Observable

Type parameters
- T
Returns Observable<Notification<T>>

an Observable that emits items that are the result of materializing the items and notifications of the source Observable.

"node_modules/rxjs/src/operator/max"

"node_modules/rxjs/src/operator/max":

MaxSignature

__call(comparer?: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/max.ts:23
Parameters
- Optional comparer: function
 - - (x: T, y: T): T
 - Parameters
 - x: T
 - y: T
 Returns T
Returns Observable<T>

max

max<T>(comparer?: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/max.ts:16
The Max operator operates on an Observable that emits numbers (or items that can be evaluated as numbers), and when source Observable completes it emits a single item: the item with the largest number.

method

max

owner

Observable

Type parameters
- T
Parameters
- Optional comparer: function
 - - (x: T, y: T): T
 - Parameters
 - x: T
 - y: T
 Returns T
Returns Observable<T>

an Observable that emits item with the largest number.

"node_modules/rxjs/src/operator/merge"

"node_modules/rxjs/src/operator/merge":

MergeSignature

__call(scheduler?: Scheduler): Observable<T>
__call(concurrent?: number, scheduler?: Scheduler): Observable<T>
__call<T2>(v2: ObservableInput, scheduler?: Scheduler): Observable<T | T2>
__call<T2>(v2: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2>
__call<T2, T3>(v2: ObservableInput, v3: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3>
__call<T2, T3>(v2: ObservableInput, v3: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2 | T3>
__call<T2, T3, T4>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4>
__call<T2, T3, T4>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2 | T3 | T4>
__call<T2, T3, T4, T5>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5>
__call<T2, T3, T4, T5>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5>
__call<T2, T3, T4, T5, T6>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5 | T6>
__call<T2, T3, T4, T5, T6>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5 | T6>
__call(...observables: Array<ObservableInput | Scheduler | number>): Observable<T>
__call<R>(...observables: Array<ObservableInput | Scheduler | number>): Observable<R>

- Defined in node_modules/rxjs/src/operator/merge.ts:59
Parameters
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/merge.ts:60
Parameters
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/merge.ts:61
Type parameters
- T2
Parameters
- v2: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2>
- Defined in node_modules/rxjs/src/operator/merge.ts:62
Type parameters
- T2
Parameters
- v2: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2>
- Defined in node_modules/rxjs/src/operator/merge.ts:63
Type parameters
- T2
- T3
Parameters
- v2: ObservableInput
- v3: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3>
- Defined in node_modules/rxjs/src/operator/merge.ts:64
Type parameters
- T2
- T3
Parameters
- v2: ObservableInput
- v3: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3>
- Defined in node_modules/rxjs/src/operator/merge.ts:65
Type parameters
- T2
- T3
- T4
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4>
- Defined in node_modules/rxjs/src/operator/merge.ts:66
Type parameters
- T2
- T3
- T4
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4>
- Defined in node_modules/rxjs/src/operator/merge.ts:67
Type parameters
- T2
- T3
- T4
- T5
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5>
- Defined in node_modules/rxjs/src/operator/merge.ts:68
Type parameters
- T2
- T3
- T4
- T5
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5>
- Defined in node_modules/rxjs/src/operator/merge.ts:69
Type parameters
- T2
- T3
- T4
- T5
- T6
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5 | T6>
- Defined in node_modules/rxjs/src/operator/merge.ts:70
Type parameters
- T2
- T3
- T4
- T5
- T6
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5 | T6>
- Defined in node_modules/rxjs/src/operator/merge.ts:71
Parameters
- Rest ...observables: Array<ObservableInput | Scheduler | number>
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/merge.ts:72
Type parameters
- R
Parameters
- Rest ...observables: Array<ObservableInput | Scheduler | number>
Returns Observable<R>

merge

merge<T, R>(...observables: Array<ObservableInput | Scheduler | number>): Observable<R>

- Defined in node_modules/rxjs/src/operator/merge.ts:53
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (either the source or an Observable given as argument), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

example

Merge together two Observables: 1s interval and clicks var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var clicksOrTimer = clicks.merge(timer); clicksOrTimer.subscribe(x => console.log(x));

example

Merge together 3 Observables, but only 2 run concurrently var timer1 = Rx.Observable.interval(1000).take(10); var timer2 = Rx.Observable.interval(2000).take(6); var timer3 = Rx.Observable.interval(500).take(10); var concurrent = 2; // the argument var merged = timer1.merge(timer2, timer3, concurrent); merged.subscribe(x => console.log(x));

see

mergeAll

see

mergeMap

see

mergeMapTo

see

mergeScan

method

merge

owner

Observable

Type parameters
- T
- R
Parameters
- Rest ...observables: Array<ObservableInput | Scheduler | number>
Returns Observable<R>

an Observable that emits items that are the result of every input Observable.

mergeStatic

mergeStatic<T>(v1: ObservableInput, scheduler?: Scheduler): Observable<T>
mergeStatic<T>(v1: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T>
mergeStatic<T, T2>(v1: ObservableInput, v2: ObservableInput, scheduler?: Scheduler): Observable<T | T2>
mergeStatic<T, T2>(v1: ObservableInput, v2: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2>
mergeStatic<T, T2, T3>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3>
mergeStatic<T, T2, T3>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2 | T3>
mergeStatic<T, T2, T3, T4>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4>
mergeStatic<T, T2, T3, T4>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2 | T3 | T4>
mergeStatic<T, T2, T3, T4, T5>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5>
mergeStatic<T, T2, T3, T4, T5>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5>
mergeStatic<T, T2, T3, T4, T5, T6>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5 | T6>
mergeStatic<T, T2, T3, T4, T5, T6>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, concurrent?: number, scheduler?: Scheduler): Observable<T | T2 | T3 | T4 | T5 | T6>
mergeStatic<T>(...observables: Subscribable<T> | Promise<T> | ArrayLike<T> | Scheduler | number): Observable<T>
mergeStatic<T, R>(...observables: Subscribable<any> | Promise<any> | ArrayLike<any> | Scheduler | number): Observable<R>

- Defined in node_modules/rxjs/src/operator/merge.ts:78
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
Parameters
- v1: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:79
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
Parameters
- v1: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:80
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
Parameters
- v1: ObservableInput
- v2: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:81
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
Parameters
- v1: ObservableInput
- v2: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:82
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
- T3
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:83
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
- T3
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:84
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
- T3
- T4
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:85
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
- T3
- T4
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:86
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
- T3
- T4
- T5
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:87
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
- T3
- T4
- T5
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:88
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
- T3
- T4
- T5
- T6
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5 | T6>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:89
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- T2
- T3
- T4
- T5
- T6
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- Optional concurrent: number
- Optional scheduler: Scheduler
Returns Observable<T | T2 | T3 | T4 | T5 | T6>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:90
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
Parameters
- Rest ...observables: Subscribable<T> | Promise<T> | ArrayLike<T> | Scheduler | number
Returns Observable<T>

an Observable that emits items that are the result of every input Observable.
- Defined in node_modules/rxjs/src/operator/merge.ts:91
Creates an output Observable which concurrently emits all values from every given input Observable.

Flattens multiple Observables together by blending their values into one Observable.

merge subscribes to each given input Observable (as arguments), and simply forwards (without doing any transformation) all the values from all the input Observables to the output Observable. The output Observable only completes once all input Observables have completed. Any error delivered by an input Observable will be immediately emitted on the output Observable.

Type parameters
- T
- R
Parameters
- Rest ...observables: Subscribable<any> | Promise<any> | ArrayLike<any> | Scheduler | number
Returns Observable<R>

an Observable that emits items that are the result of every input Observable.

"node_modules/rxjs/src/operator/mergeAll"

"node_modules/rxjs/src/operator/mergeAll":

MergeAllOperator

MergeAllOperator:

constructor

new MergeAllOperator(concurrent: number): MergeAllOperator

- Defined in node_modules/rxjs/src/operator/mergeAll.ts:60
Parameters
- concurrent: number
Returns MergeAllOperator

concurrent

concurrent: number

call

call(observer: Observer<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/mergeAll.ts:64
Parameters
- observer: Observer<T>
- source: any
Returns any

MergeAllSubscriber

MergeAllSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new MergeAllSubscriber(destination: Observer<T>, concurrent: number): MergeAllSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/mergeAll.ts:77
Parameters
- destination: Observer<T>
- concurrent: number
Returns MergeAllSubscriber

active

active: number

buffer

buffer: Observable<T>[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/mergeAll.ts:92
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(observable: Observable<T>): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/mergeAll.ts:83
Parameters
- observable: Observable<T>
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: Observable<T>): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: Observable<T>
Returns void

notifyComplete

notifyComplete(innerSub: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/mergeAll.ts:99
Parameters
- innerSub: Subscription
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<Observable<T>, T>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<Observable<T>, T>
Returns void

notifyNext

notifyNext(outerValue: Observable<T>, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<Observable<T>, T>): void

Inherited from OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:10
Parameters
- outerValue: Observable<T>
- innerValue: T
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<Observable<T>, T>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MergeAllSignature

__call(concurrent?: number): T

- Defined in node_modules/rxjs/src/operator/mergeAll.ts:56
Parameters
- Optional concurrent: number
Returns T

mergeAll

mergeAll<T>(concurrent?: number): T

- Defined in node_modules/rxjs/src/operator/mergeAll.ts:52
Converts a higher-order Observable into a first-order Observable which concurrently delivers all values that are emitted on the inner Observables.

Flattens an Observable-of-Observables.

mergeAll subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, it subscribes to that and delivers all the values from the inner Observable on the output Observable. The output Observable only completes once all inner Observables have completed. Any error delivered by a inner Observable will be immediately emitted on the output Observable.

example

Spawn a new interval Observable for each click event, and blend their outputs as one Observable var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var firstOrder = higherOrder.mergeAll(); firstOrder.subscribe(x => console.log(x));

example

Count from 0 to 9 every second for each click, but only allow 2 concurrent timers var clicks = Rx.Observable.fromEvent(document, 'click'); var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000).take(10)); var firstOrder = higherOrder.mergeAll(2); firstOrder.subscribe(x => console.log(x));

see

combineAll

see

concatAll

see

exhaust

see

merge

see

mergeMap

see

mergeMapTo

see

mergeScan

see

switch

see

zipAll

method

mergeAll

owner

Observable

Type parameters
- T
Parameters
- Default value concurrent: number = Number.POSITIVE_INFINITY
Returns T

An Observable that emits values coming from all the inner Observables emitted by the source Observable.

"node_modules/rxjs/src/operator/mergeMap"

"node_modules/rxjs/src/operator/mergeMap":

MergeMapOperator

MergeMapOperator:

constructor

new MergeMapOperator(project: function, resultSelector?: function, concurrent?: number): MergeMapOperator

- Defined in node_modules/rxjs/src/operator/mergeMap.ts:75
Parameters
- project: function
  - - (value: T, index: number): ObservableInput
    - Parameters
      - value: T
      - index: number
      Returns ObservableInput
- Optional resultSelector: function
  - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
    - Parameters
      - outerValue: T
      - innerValue: I
      - outerIndex: number
      - innerIndex: number
      Returns R
- Default value concurrent: number = Number.POSITIVE_INFINITY
Returns MergeMapOperator

concurrent

concurrent: number

project

project: function

Type declaration

- (value: T, index: number): ObservableInput
- Parameters
  - value: T
  - index: number
  Returns ObservableInput

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

call

call(observer: Subscriber, source: any): any

- Defined in node_modules/rxjs/src/operator/mergeMap.ts:81
Parameters
- observer: Subscriber
- source: any
Returns any

MergeMapSubscriber

MergeMapSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new MergeMapSubscriber(destination: Subscriber, project: function, resultSelector?: function, concurrent?: number): MergeMapSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/mergeMap.ts:97
Parameters
- destination: Subscriber
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
- Default value concurrent: number = Number.POSITIVE_INFINITY
Returns MergeMapSubscriber

active

active: number

buffer

buffer: Observable<any>[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

project

project: function

Type declaration

- (value: T, index: number): ObservableInput
- Parameters
  - value: T
  - index: number
  Returns ObservableInput

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/mergeMap.ts:131
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_innerSub

_innerSub(ish: any, value: T, index: number): void

- Defined in node_modules/rxjs/src/operator/mergeMap.ts:127
Parameters
- ish: any
- value: T
- index: number
Returns void

_next

_next(value: any): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/mergeMap.ts:106
Parameters
- value: any
Returns void

_notifyResultSelector

_notifyResultSelector(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

- Defined in node_modules/rxjs/src/operator/mergeMap.ts:148
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
Returns void

_tryNext

_tryNext(value: any): void

- Defined in node_modules/rxjs/src/operator/mergeMap.ts:114
Parameters
- value: any
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/mergeMap.ts:159
Parameters
- innerSub: Subscription
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, I>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, I>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/mergeMap.ts:138
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, I>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MergeMapSignature

__call<R>(project: function, concurrent?: number): Observable<R>
__call<I, R>(project: function, resultSelector: function, concurrent?: number): Observable<R>

- Defined in node_modules/rxjs/src/operator/mergeMap.ts:68
Type parameters
- R
Parameters
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- Optional concurrent: number
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/mergeMap.ts:69
Type parameters
- I
- R
Parameters
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
- Optional concurrent: number
Returns Observable<R>

mergeMap

mergeMap<T, I, R>(project: function, resultSelector?: function | number, concurrent?: number): Observable<R>

- Defined in node_modules/rxjs/src/operator/mergeMap.ts:58
Projects each source value to an Observable which is merged in the output Observable.

Maps each value to an Observable, then flattens all of these inner Observables using mergeAll.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an Observable, and then merging those resulting Observables and emitting the results of this merger.

example

Map and flatten each letter to an Observable ticking every 1 second var letters = Rx.Observable.of('a', 'b', 'c'); var result = letters.mergeMap(x => Rx.Observable.interval(1000).map(i => x+i) ); result.subscribe(x => console.log(x));

see

concatMap

see

exhaustMap

see

merge

see

mergeAll

see

mergeMapTo

see

mergeScan

see

switchMap

method

mergeMap

owner

Observable

Type parameters
- T
- I
- R
Parameters
- project: function
 
 A function that, when applied to an item emitted by the source Observable, returns an Observable.
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- Optional resultSelector: function | number
- Default value concurrent: number = Number.POSITIVE_INFINITY
Returns Observable<R>

An Observable that emits the result of applying the projection function (and the optional resultSelector) to each item emitted by the source Observable and merging the results of the Observables obtained from this transformation.

"node_modules/rxjs/src/operator/mergeMapTo"

"node_modules/rxjs/src/operator/mergeMapTo":

MergeMapToOperator

MergeMapToOperator:

constructor

new MergeMapToOperator(ish: SubscribableOrPromise, resultSelector?: function, concurrent?: number): MergeMapToOperator

- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:72
Parameters
- ish: SubscribableOrPromise
- Optional resultSelector: function
  - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
    - Parameters
      - outerValue: T
      - innerValue: I
      - outerIndex: number
      - innerIndex: number
      Returns R
- Default value concurrent: number = Number.POSITIVE_INFINITY
Returns MergeMapToOperator

concurrent

concurrent: number

ish

ish: SubscribableOrPromise

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

call

call(observer: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:78
Parameters
- observer: Subscriber<R>
- source: any
Returns any

MergeMapToSubscriber

MergeMapToSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new MergeMapToSubscriber(destination: Subscriber<R>, ish: SubscribableOrPromise, resultSelector?: function, concurrent?: number): MergeMapToSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:92
Parameters
- destination: Subscriber<R>
- ish: SubscribableOrPromise
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
- Default value concurrent: number = Number.POSITIVE_INFINITY
Returns MergeMapToSubscriber

active

active: number

buffer

buffer: Observable<any>[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

ish

ish: SubscribableOrPromise

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:123
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_innerSub

_innerSub(ish: any, destination: PartialObserver, resultSelector: function, value: T, index: number): void

- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:115
Parameters
- ish: any
- destination: PartialObserver
- resultSelector: function
  - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
    - Parameters
      - outerValue: T
      - innerValue: I
      - outerIndex: number
      - innerIndex: number
      Returns R
- value: T
- index: number
Returns void

_next

_next(value: any): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:101
Parameters
- value: any
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:159
Parameters
- innerSub: Subscription
Returns void

notifyError

notifyError(err: any): void

Overwrites OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:155
Parameters
- err: any
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:130
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, I>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

trySelectResult

trySelectResult(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:141
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MergeMapToSignature

__call<R>(observable: ObservableInput, concurrent?: number): Observable<R>
__call<I, R>(observable: ObservableInput, resultSelector: function, concurrent?: number): Observable<R>

- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:63
Type parameters
- R
Parameters
- observable: ObservableInput
- Optional concurrent: number
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:64
Type parameters
- I
- R
Parameters
- observable: ObservableInput
- resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
- Optional concurrent: number
Returns Observable<R>

mergeMapTo

mergeMapTo<T, I, R>(innerObservable: Observable, resultSelector?: function | number, concurrent?: number): Observable<R>

- Defined in node_modules/rxjs/src/operator/mergeMapTo.ts:53
Projects each source value to the same Observable which is merged multiple times in the output Observable.

It's like mergeMap, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then merges those resulting Observables into one single Observable, which is the output Observable.

example

For each click event, start an interval Observable ticking every 1 second var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.mergeMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

see

concatMapTo

see

merge

see

mergeAll

see

mergeMap

see

mergeScan

see

switchMapTo

method

mergeMapTo

owner

Observable

Type parameters
- T
- I
- R
Parameters
- innerObservable: Observable
 
 An Observable to replace each value from the source Observable.
- Optional resultSelector: function | number
- Default value concurrent: number = Number.POSITIVE_INFINITY
Returns Observable<R>

An Observable that emits items from the given innerObservable (and optionally transformed through resultSelector) every time a value is emitted on the source Observable.

"node_modules/rxjs/src/operator/mergeScan"

"node_modules/rxjs/src/operator/mergeScan":

MergeScanOperator

MergeScanOperator:

constructor

new MergeScanOperator(project: function, seed: R, concurrent: number): MergeScanOperator

- Defined in node_modules/rxjs/src/operator/mergeScan.ts:29
Parameters
- project: function
 - - (acc: R, value: T): Observable<R>
 - Parameters
 - acc: R
 - value: T
 Returns Observable<R>
- seed: R
- concurrent: number
Returns MergeScanOperator

concurrent

concurrent: number

project

project: function

Type declaration

- (acc: R, value: T): Observable<R>
- Parameters
 - acc: R
 - value: T
 Returns Observable<R>

seed

seed: R

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/mergeScan.ts:35
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

MergeScanSubscriber

MergeScanSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new MergeScanSubscriber(destination: Subscriber<R>, project: function, acc: R, concurrent: number): MergeScanSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/mergeScan.ts:52
Parameters
- destination: Subscriber<R>
- project: function
 - - (acc: R, value: T): Observable<R>
 - Parameters
 - acc: R
 - value: T
 Returns Observable<R>
- acc: R
- concurrent: number
Returns MergeScanSubscriber

acc

acc: R

active

active: number

buffer

buffer: Observable<any>[]

concurrent

concurrent: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

hasValue

hasValue: boolean

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

project

project: function

Type declaration

- (acc: R, value: T): Observable<R>
- Parameters
 - acc: R
 - value: T
 Returns Observable<R>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/mergeScan.ts:81
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_innerSub

_innerSub(ish: any, value: T, index: number): void

- Defined in node_modules/rxjs/src/operator/mergeScan.ts:77
Parameters
- ish: any
- value: T
- index: number
Returns void

_next

_next(value: any): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/mergeScan.ts:61
Parameters
- value: any
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/mergeScan.ts:100
Parameters
- innerSub: Subscription
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/mergeScan.ts:91
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

MergeScanSignature

__call<R>(project: function, seed: R, concurrent?: number): Observable<R>

- Defined in node_modules/rxjs/src/operator/mergeScan.ts:25
Type parameters
- R
Parameters
- project: function
 - - (acc: R, value: T): Observable<R>
 - Parameters
 - acc: R
 - value: T
 Returns Observable<R>
- seed: R
- Optional concurrent: number
Returns Observable<R>

mergeScan

mergeScan<T, R>(project: function, seed: R, concurrent?: number): Observable<R>

- Defined in node_modules/rxjs/src/operator/mergeScan.ts:19
method

mergeScan

owner

Observable

Type parameters
- T
- R
Parameters
- project: function
 - - (acc: R, value: T): Observable<R>
 - Parameters
 - acc: R
 - value: T
 Returns Observable<R>
- seed: R
- Default value concurrent: number = Number.POSITIVE_INFINITY
Returns Observable<R>

"node_modules/rxjs/src/operator/min"

"node_modules/rxjs/src/operator/min":

MinSignature

__call(comparer?: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/min.ts:22
Parameters
- Optional comparer: function
 - - (x: T, y: T): T
 - Parameters
 - x: T
 - y: T
 Returns T
Returns Observable<T>

min

min<T>(comparer?: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/min.ts:15
The Min operator operates on an Observable that emits numbers (or items that can be evaluated as numbers), and when source Observable completes it emits a single item: the item with the smallest number.

method

min

owner

Observable

Type parameters
- T
Parameters
- Optional comparer: function
 - - (x: T, y: T): T
 - Parameters
 - x: T
 - y: T
 Returns T
Returns Observable<T>

an Observable that emits item with the smallest number.

"node_modules/rxjs/src/operator/multicast"

"node_modules/rxjs/src/operator/multicast":

MulticastSignature

__call(subjectOrSubjectFactory: factoryOrValue): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/multicast.ts:34
Parameters
- subjectOrSubjectFactory: factoryOrValue
Returns ConnectableObservable<T>

factoryOrValue

factoryOrValue: T | function

multicast

multicast<T>(subjectOrSubjectFactory: Subject<T> | function): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/multicast.ts:20
Returns an Observable that emits the results of invoking a specified selector on items emitted by a ConnectableObservable that shares a single subscription to the underlying stream.

method

multicast

owner

Observable

Type parameters
- T
Parameters
- subjectOrSubjectFactory: Subject<T> | function
Returns ConnectableObservable<T>

an Observable that emits the results of invoking the selector on the items emitted by a ConnectableObservable that shares a single subscription to the underlying stream.

"node_modules/rxjs/src/operator/observeOn"

"node_modules/rxjs/src/operator/observeOn":

ObserveOnMessage

ObserveOnMessage:

constructor

new ObserveOnMessage(notification: Notification<any>, destination: PartialObserver): ObserveOnMessage

- Defined in node_modules/rxjs/src/operator/observeOn.ts:70
Parameters
- notification: Notification<any>
- destination: PartialObserver
Returns ObserveOnMessage

destination

destination: PartialObserver

notification

notification: Notification<any>

ObserveOnOperator

ObserveOnOperator:

constructor

new ObserveOnOperator(scheduler: Scheduler, delay?: number): ObserveOnOperator

- Defined in node_modules/rxjs/src/operator/observeOn.ts:25
Parameters
- scheduler: Scheduler
- Default value delay: number = 0
Returns ObserveOnOperator

delay

delay: number

scheduler

scheduler: Scheduler

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/observeOn.ts:29
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

ObserveOnSubscriber

ObserveOnSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ObserveOnSubscriber(destination: Subscriber<T>, scheduler: Scheduler, delay?: number): ObserveOnSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/observeOn.ts:43
Parameters
- destination: Subscriber<T>
- scheduler: Scheduler
- Default value delay: number = 0
Returns ObserveOnSubscriber

delay

delay: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/observeOn.ts:65
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/observeOn.ts:61
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/observeOn.ts:57
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

scheduleMessage

scheduleMessage(notification: Notification<any>): void

- Defined in node_modules/rxjs/src/operator/observeOn.ts:51
Parameters
- notification: Notification<any>
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatch

dispatch(arg: ObserveOnMessage): void

- Defined in node_modules/rxjs/src/operator/observeOn.ts:40
Parameters
- arg: ObserveOnMessage
Returns void

ObserveOnSignature

__call(scheduler: Scheduler, delay?: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/observeOn.ts:21
Parameters
- scheduler: Scheduler
- Optional delay: number
Returns Observable<T>

observeOn

observeOn<T>(scheduler: Scheduler, delay?: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/observeOn.ts:17
see

Notification

method

observeOn

owner

Observable

Type parameters
- T
Parameters
- scheduler: Scheduler
- Default value delay: number = 0
Returns Observable<T>

"node_modules/rxjs/src/operator/pairwise"

"node_modules/rxjs/src/operator/pairwise":

PairwiseOperator

PairwiseOperator:

call

call(subscriber: Subscriber<[T, T]>, source: any): any

- Defined in node_modules/rxjs/src/operator/pairwise.ts:25
Parameters
- subscriber: Subscriber<[T, T]>
- source: any
Returns any

PairwiseSubscriber

PairwiseSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new PairwiseSubscriber(destination: Subscriber<[T, T]>): PairwiseSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/pairwise.ts:37
Parameters
- destination: Subscriber<[T, T]>
Returns PairwiseSubscriber

destination

destination: PartialObserver

hasPrev

hasPrev: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

prev: T

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/pairwise.ts:43
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

PairwiseSignature

__call(): Observable<[T, T]>

- Defined in node_modules/rxjs/src/operator/pairwise.ts:20
Returns Observable<[T, T]>

pairwise

pairwise<T>(): Observable<[T, T]>

- Defined in node_modules/rxjs/src/operator/pairwise.ts:16
Returns a new observable that triggers on the second and following inputs. An input that triggers an event will return an pair of [(N - 1)th, Nth]. The (N-1)th is stored in the internal state until Nth input occurs.

method

pairwise

owner

Observable

Type parameters
- T
Returns Observable<[T, T]>

an observable of pairs of values.

"node_modules/rxjs/src/operator/partition"

"node_modules/rxjs/src/operator/partition":

PartitionSignature

__call(predicate: function, thisArg?: any): [Observable<T>, Observable<T>]

- Defined in node_modules/rxjs/src/operator/partition.ts:19
Parameters
- predicate: function
 - - (value: T): boolean
 - Parameters
 - value: T
 Returns boolean
- Optional thisArg: any
Returns [Observable<T>, Observable<T>]

partition

partition<T>(predicate: function, thisArg?: any): [Observable<T>, Observable<T>]

- Defined in node_modules/rxjs/src/operator/partition.ts:12
method

partition

owner

Observable

Type parameters
- T
Parameters
- predicate: function
 - - (value: T): boolean
 - Parameters
 - value: T
 Returns boolean
- Optional thisArg: any
Returns [Observable<T>, Observable<T>]

"node_modules/rxjs/src/operator/pluck"

"node_modules/rxjs/src/operator/pluck":

PluckSignature

__call<R>(...properties: string[]): Observable<R>

- Defined in node_modules/rxjs/src/operator/pluck.ts:39
Type parameters
- R
Parameters
- Rest ...properties: string[]
Returns Observable<R>

pluck

pluck<R>(...properties: string[]): Observable<R>

- Defined in node_modules/rxjs/src/operator/pluck.ts:31
Maps each source value (an object) to its specified nested property.

Like map, but meant only for picking one of the nested properties of every emitted object.

Given a list of strings describing a path to an object property, retrieves the value of a specified nested property from all values in the source Observable. If a property can't be resolved, it will return undefined for that value.

example

Map every every click to the tagName of the clicked target element var clicks = Rx.Observable.fromEvent(document, 'click'); var tagNames = clicks.pluck('target', 'tagName'); tagNames.subscribe(x => console.log(x));

see

map

method

pluck

owner

Observable

Type parameters
- R
Parameters
- Rest ...properties: string[]
 
 The nested properties to pluck from each source value (an object).
Returns Observable<R>

Returns a new Observable of property values from the source values.

plucker

plucker(props: string[], length: number): function

- Defined in node_modules/rxjs/src/operator/pluck.ts:43
Parameters
- props: string[]
- length: number
Returns function
- - (x: string): any
  - Parameters
    - x: string
    Returns any

"node_modules/rxjs/src/operator/publish"

"node_modules/rxjs/src/operator/publish":

PublishSignature

__call(): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/publish.ts:19
Returns ConnectableObservable<T>

publish

publish<T>(): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/publish.ts:15
Returns a ConnectableObservable, which is a variety of Observable that waits until its connect method is called before it begins emitting items to those Observers that have subscribed to it.

method

publish

owner

Observable

Type parameters
- T
Returns ConnectableObservable<T>

a ConnectableObservable that upon connection causes the source Observable to emit items to its Observers.

"node_modules/rxjs/src/operator/publishBehavior"

"node_modules/rxjs/src/operator/publishBehavior":

PublishBehaviorSignature

__call(value: T): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/publishBehavior.ts:15
Parameters
- value: T
Returns ConnectableObservable<T>

publishBehavior

publishBehavior<T>(value: T): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/publishBehavior.ts:11
method

publishBehavior

owner

Observable

Type parameters
- T
Parameters
- value: T
Returns ConnectableObservable<T>

"node_modules/rxjs/src/operator/publishLast"

"node_modules/rxjs/src/operator/publishLast":

PublishLastSignature

__call(): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/publishLast.ts:14
Returns ConnectableObservable<T>

publishLast

publishLast<T>(): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/publishLast.ts:10
method

publishLast

owner

Observable

Type parameters
- T
Returns ConnectableObservable<T>

"node_modules/rxjs/src/operator/publishReplay"

"node_modules/rxjs/src/operator/publishReplay":

PublishReplaySignature

__call(bufferSize?: number, windowTime?: number, scheduler?: Scheduler): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/publishReplay.ts:20
Parameters
- Optional bufferSize: number
- Optional windowTime: number
- Optional scheduler: Scheduler
Returns ConnectableObservable<T>

publishReplay

publishReplay<T>(bufferSize?: number, windowTime?: number, scheduler?: Scheduler): ConnectableObservable<T>

- Defined in node_modules/rxjs/src/operator/publishReplay.ts:14
method

publishReplay

owner

Observable

Type parameters
- T
Parameters
- Default value bufferSize: number = Number.POSITIVE_INFINITY
- Default value windowTime: number = Number.POSITIVE_INFINITY
- Optional scheduler: Scheduler
Returns ConnectableObservable<T>

"node_modules/rxjs/src/operator/race"

"node_modules/rxjs/src/operator/race":

RaceOperator

RaceOperator:

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/race.ts:59
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

RaceSubscriber

RaceSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new RaceSubscriber(destination: Subscriber<T>): RaceSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/race.ts:72
Parameters
- destination: Subscriber<T>
Returns RaceSubscriber

destination

destination: PartialObserver

hasFirst

hasFirst: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

observables

observables: Observable<any>[]

subscriptions

subscriptions: Subscription[]

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/race.ts:82
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(observable: any): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/race.ts:78
Parameters
- observable: any
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:20
Parameters
- innerSub: InnerSubscriber<T, T>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, T>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, T>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: T, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, T>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/race.ts:99
Parameters
- outerValue: T
- innerValue: T
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, T>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

RaceSignature

__call(...observables: Array<Observable<T> | Array<Observable<T>>>): Observable<T>
__call<R>(...observables: Array<Observable<any> | Array<Observable<T>>>): Observable<R>

- Defined in node_modules/rxjs/src/operator/race.ts:30
Parameters
- Rest ...observables: Array<Observable<T> | Array<Observable<T>>>
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/race.ts:31
Type parameters
- R
Parameters
- Rest ...observables: Array<Observable<any> | Array<Observable<T>>>
Returns Observable<R>

race

race<T>(...observables: Array<Observable<T> | Array<Observable<T>>>): Observable<T>

- Defined in node_modules/rxjs/src/operator/race.ts:19
Returns an Observable that mirrors the first source Observable to emit an item from the combination of this Observable and supplied Observables

method

race

owner

Observable

Type parameters
- T
Parameters
- Rest ...observables: Array<Observable<T> | Array<Observable<T>>>
Returns Observable<T>

an Observable that mirrors the output of the first Observable to emit an item.

raceStatic

raceStatic<T>(...observables: Array<Observable<T> | Array<Observable<T>>>): Observable<T>

- Defined in node_modules/rxjs/src/operator/race.ts:43
Returns an Observable that mirrors the first source Observable to emit an item.

static

true

name

race

owner

Observable

Type parameters
- T
Parameters
- Rest ...observables: Array<Observable<T> | Array<Observable<T>>>
Returns Observable<T>

an Observable that mirrors the output of the first Observable to emit an item.

"node_modules/rxjs/src/operator/reduce"

"node_modules/rxjs/src/operator/reduce":

ReduceOperator

ReduceOperator:

constructor

new ReduceOperator(project: function, seed?: R): ReduceOperator

- Defined in node_modules/rxjs/src/operator/reduce.ts:31
Parameters
- project: function
  - - (acc: R, value: T): R
    - Parameters
      - acc: R
      - value: T
      Returns R
- Optional seed: R
Returns ReduceOperator

project

project: function

Type declaration

- (acc: R, value: T): R
- Parameters
  - acc: R
  - value: T
  Returns R

seed

seed: R

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/reduce.ts:36
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

ReduceSubscriber

ReduceSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ReduceSubscriber(destination: Subscriber<R>, project: function, seed?: R): ReduceSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/reduce.ts:51
Parameters
- destination: Subscriber<R>
- project: function
 - - (acc: R, value: T): R
 - Parameters
 - acc: R
 - value: T
 Returns R
- Optional seed: R
Returns ReduceSubscriber

acc

acc: T | R

destination

destination: PartialObserver

hasSeed

hasSeed: boolean

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

project

project: function

Type declaration

- (acc: R, value: T): R
- Parameters
  - acc: R
  - value: T
  Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/reduce.ts:80
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/reduce.ts:60
Parameters
- value: T
Returns void

_tryReduce

_tryReduce(value: T): void

- Defined in node_modules/rxjs/src/operator/reduce.ts:69
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ReduceSignature

__call<R>(project: function, seed?: R): Observable<R>

- Defined in node_modules/rxjs/src/operator/reduce.ts:27
Type parameters
- R
Parameters
- project: function
 - - (acc: R, value: T): R
 - Parameters
 - acc: R
 - value: T
 Returns R
- Optional seed: R
Returns Observable<R>

reduce

reduce<T, R>(project: function, seed?: R): Observable<R>

- Defined in node_modules/rxjs/src/operator/reduce.ts:23
Returns an Observable that applies a specified accumulator function to the first item emitted by a source Observable, then feeds the result of that function along with the second item emitted by the source Observable into the same function, and so on until all items have been emitted by the source Observable, and emits the final result from the final call to your function as its sole item. This technique, which is called "reduce" here, is sometimes called "aggregate," "fold," "accumulate," "compress," or "inject" in other programming contexts.

method

reduce

owner

Observable

Type parameters
- T
- R
Parameters
- project: function
 - - (acc: R, value: T): R
 - Parameters
 - acc: R
 - value: T
 Returns R
- Optional seed: R
Returns Observable<R>

an Observable that emits a single item that is the result of accumulating the output from the items emitted by the source Observable.

"node_modules/rxjs/src/operator/repeat"

"node_modules/rxjs/src/operator/repeat":

RepeatOperator

RepeatOperator:

constructor

new RepeatOperator(count: number, source: Observable<T>): RepeatOperator

- Defined in node_modules/rxjs/src/operator/repeat.ts:34
Parameters
- count: number
- source: Observable<T>
Returns RepeatOperator

count

source

source: Observable<T>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/repeat.ts:38
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

RepeatSubscriber

RepeatSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new RepeatSubscriber(destination: Subscriber<any>, count: number, source: Observable<T>): RepeatSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/repeat.ts:48
Parameters
- destination: Subscriber<any>
- count: number
- source: Observable<T>
Returns RepeatSubscriber

count

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Overwrites Subscriber.complete
- Defined in node_modules/rxjs/src/operator/repeat.ts:54
Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

RepeatSignature

__call(count?: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/repeat.ts:30
Parameters
- Optional count: number
Returns Observable<T>

repeat

repeat<T>(count?: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/repeat.ts:20
Returns an Observable that repeats the stream of items emitted by the source Observable at most count times, on a particular Scheduler.

method

repeat

owner

Observable

Type parameters
- T
Parameters
- Default value count: number = -1
Returns Observable<T>

an Observable that repeats the stream of items emitted by the source Observable at most count times.

"node_modules/rxjs/src/operator/retry"

"node_modules/rxjs/src/operator/retry":

RetryOperator

RetryOperator:

constructor

new RetryOperator(count: number, source: Observable<T>): RetryOperator

- Defined in node_modules/rxjs/src/operator/retry.ts:30
Parameters
- count: number
- source: Observable<T>
Returns RetryOperator

count

source

source: Observable<T>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/retry.ts:35
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

RetrySubscriber

RetrySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new RetrySubscriber(destination: Subscriber<any>, count: number, source: Observable<T>): RetrySubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/retry.ts:45
Parameters
- destination: Subscriber<any>
- count: number
- source: Observable<T>
Returns RetrySubscriber

count

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err: any): void

Overwrites Subscriber.error
- Defined in node_modules/rxjs/src/operator/retry.ts:51
Parameters
- err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

RetrySignature

__call(count?: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/retry.ts:26
Parameters
- Optional count: number
Returns Observable<T>

retry

retry<T>(count?: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/retry.ts:22
Returns an Observable that mirrors the source Observable, resubscribing to it if it calls error and the predicate returns true for that specific exception and retry count. If the source Observable calls error, this method will resubscribe to the source Observable for a maximum of count resubscriptions (given as a number parameter) rather than propagating the error call.

Any and all items emitted by the source Observable will be emitted by the resulting Observable, even those emitted during failed subscriptions. For example, if an Observable fails at first but emits [1, 2] then succeeds the second time and emits: [1, 2, 3, 4, 5] then the complete stream of emissions and notifications would be: [1, 2, 1, 2, 3, 4, 5, complete].

method

retry

owner

Observable

Type parameters
- T
Parameters
- Default value count: number = -1
Returns Observable<T>

the source Observable modified with the retry logic.

"node_modules/rxjs/src/operator/retryWhen"

"node_modules/rxjs/src/operator/retryWhen":

RetryWhenOperator

RetryWhenOperator:

constructor

new RetryWhenOperator(notifier: function, source: Observable<T>): RetryWhenOperator

- Defined in node_modules/rxjs/src/operator/retryWhen.ts:37
Parameters
- notifier: function
 - - (errors: Observable<any>): Observable<any>
 - Parameters
 - errors: Observable<any>
 Returns Observable<any>
- source: Observable<T>
Returns RetryWhenOperator

notifier

notifier: function

Type declaration

- (errors: Observable<any>): Observable<any>
- Parameters
 - errors: Observable<any>
 Returns Observable<any>

source

source: Observable<T>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/retryWhen.ts:42
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

RetryWhenSubscriber

RetryWhenSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new RetryWhenSubscriber(destination: Subscriber<R>, notifier: function, source: Observable<T>): RetryWhenSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/retryWhen.ts:56
Parameters
- destination: Subscriber<R>
- notifier: function
 - - (errors: Observable<any>): Observable<any>
 - Parameters
 - errors: Observable<any>
 Returns Observable<any>
- source: Observable<T>
Returns RetryWhenSubscriber

destination

destination: PartialObserver

errors

errors: Subject<any>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

notifier

notifier: function

Type declaration

- (errors: Observable<any>): Observable<any>
- Parameters
 - errors: Observable<any>
 Returns Observable<any>

retries

retries: Observable<any>

retriesSubscription

retriesSubscription: Subscription

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/operator/retryWhen.ts:94
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err: any): void

Overwrites Subscriber.error
- Defined in node_modules/rxjs/src/operator/retryWhen.ts:64
Parameters
- err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:20
Parameters
- innerSub: InnerSubscriber<T, R>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/retryWhen.ts:107
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

RetryWhenSignature

__call(notifier: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/retryWhen.ts:33
Parameters
- notifier: function
 - - (errors: Observable<any>): Observable<any>
 - Parameters
 - errors: Observable<any>
 Returns Observable<any>
Returns Observable<T>

retryWhen

retryWhen<T>(notifier: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/retryWhen.ts:29
Returns an Observable that emits the same values as the source observable with the exception of an error. An error will cause the emission of the Throwable that cause the error to the Observable returned from notificationHandler. If that Observable calls onComplete or error then retry will call complete or error on the child subscription. Otherwise, this Observable will resubscribe to the source observable, on a particular Scheduler.

method

retryWhen

owner

Observable

Type parameters
- T
Parameters
- notifier: function
 - - (errors: Observable<any>): Observable<any>
 - Parameters
 - errors: Observable<any>
 Returns Observable<any>
Returns Observable<T>

the source Observable modified with retry logic.

"node_modules/rxjs/src/operator/sample"

"node_modules/rxjs/src/operator/sample":

SampleOperator

SampleOperator:

constructor

new SampleOperator(notifier: Observable<any>): SampleOperator

- Defined in node_modules/rxjs/src/operator/sample.ts:30
Parameters
- notifier: Observable<any>
Returns SampleOperator

notifier

notifier: Observable<any>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/sample.ts:34
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

SampleSubscriber

SampleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SampleSubscriber(destination: Subscriber<any>, notifier: Observable<any>): SampleSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/sample.ts:46
Parameters
- destination: Subscriber<any>
- notifier: Observable<any>
Returns SampleSubscriber

destination

destination: PartialObserver

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

value

value: T

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/sample.ts:53
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

emitValue

emitValue(): void

- Defined in node_modules/rxjs/src/operator/sample.ts:68
Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/sample.ts:64
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/sample.ts:58
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SampleSignature

__call(notifier: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/sample.ts:26
Parameters
- notifier: Observable<any>
Returns Observable<T>

sample

sample<T>(notifier: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/sample.ts:22
Returns an Observable that, when the specified sampler Observable emits an item or completes, it then emits the most recently emitted item (if any) emitted by the source Observable since the previous emission from the sampler Observable.

method

sample

owner

Observable

Type parameters
- T
Parameters
- notifier: Observable<any>
Returns Observable<T>

an Observable that emits the results of sampling the items emitted by this Observable whenever the sampler Observable emits an item or completes.

"node_modules/rxjs/src/operator/sampleTime"

"node_modules/rxjs/src/operator/sampleTime":

SampleTimeOperator

SampleTimeOperator:

constructor

new SampleTimeOperator(delay: number, scheduler: Scheduler): SampleTimeOperator

- Defined in node_modules/rxjs/src/operator/sampleTime.ts:22
Parameters
- delay: number
- scheduler: Scheduler
Returns SampleTimeOperator

delay

delay: number

scheduler

scheduler: Scheduler

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/sampleTime.ts:26
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

SampleTimeSubscriber

SampleTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SampleTimeSubscriber(destination: Subscriber<T>, delay: number, scheduler: Scheduler): SampleTimeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/sampleTime.ts:38
Parameters
- destination: Subscriber<T>
- delay: number
- scheduler: Scheduler
Returns SampleTimeSubscriber

delay

delay: number

destination

destination: PartialObserver

hasValue

hasValue: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

lastValue

lastValue: T

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/sampleTime.ts:45
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyNext

notifyNext(): void

- Defined in node_modules/rxjs/src/operator/sampleTime.ts:50
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SampleTimeSignature

__call(delay: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/sampleTime.ts:18
Parameters
- delay: number
- Optional scheduler: Scheduler
Returns Observable<T>

dispatchNotification

dispatchNotification<T>(state: any): void

- Defined in node_modules/rxjs/src/operator/sampleTime.ts:58
Type parameters
- T
Parameters
- state: any
Returns void

sampleTime

sampleTime<T>(delay: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/sampleTime.ts:14
method

sampleTime

owner

Observable

Type parameters
- T
Parameters
- delay: number
- Default value scheduler: Scheduler = async
Returns Observable<T>

"node_modules/rxjs/src/operator/scan"

"node_modules/rxjs/src/operator/scan":

ScanOperator

ScanOperator:

constructor

new ScanOperator(accumulator: function, seed?: T | R): ScanOperator

- Defined in node_modules/rxjs/src/operator/scan.ts:50
Parameters
- accumulator: function
  - - (acc: R, value: T): R
    - Parameters
      - acc: R
      - value: T
      Returns R
- Optional seed: T | R
Returns ScanOperator

accumulator

accumulator: function

Type declaration

- (acc: R, value: T): R
- Parameters
  - acc: R
  - value: T
  Returns R

seed

seed: T | R

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/scan.ts:54
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

ScanSubscriber

ScanSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ScanSubscriber(destination: Subscriber<R>, accumulator: function, seed?: T | R): ScanSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/scan.ts:76
Parameters
- destination: Subscriber<R>
- accumulator: function
 - - (acc: R, value: T): R
 - Parameters
 - acc: R
 - value: T
 Returns R
- Optional seed: T | R
Returns ScanSubscriber

_seed

_seed: T | R

accumulator

accumulator: function

Type declaration

- (acc: R, value: T): R
- Parameters
  - acc: R
  - value: T
  Returns R

accumulatorSet

accumulatorSet: boolean

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

seed

seed:

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/scan.ts:85
Parameters
- value: T
Returns void

_tryNext

_tryNext(value: T): void

- Defined in node_modules/rxjs/src/operator/scan.ts:94
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ScanSignature

__call<R>(accumulator: function, seed?: T | R): Observable<R>

- Defined in node_modules/rxjs/src/operator/scan.ts:46
Type parameters
- R
Parameters
- accumulator: function
 - - (acc: R, value: T): R
 - Parameters
 - acc: R
 - value: T
 Returns R
- Optional seed: T | R
Returns Observable<R>

scan

scan<T, R>(accumulator: function, seed?: T | R): Observable<R>

- Defined in node_modules/rxjs/src/operator/scan.ts:42
Applies an accumulation function over the source Observable, and returns each intermediate result, with an optional seed value.

It's like reduce, but emits the current accumulation whenever the source emits a value.

Combines together all values emitted on the source, using an accumulator function that knows how to join a new source value into the accumulation from the past. Is similar to reduce, but emits the intermediate accumulations.

Returns an Observable that applies a specified accumulator function to each item emitted by the source Observable. If a seed value is specified, then that value will be used as the initial value for the accumulator. If no seed value is specified, the first item of the source is used as the seed.

example

Count the number of click events var clicks = Rx.Observable.fromEvent(document, 'click'); var ones = clicks.mapTo(1); var seed = 0; var count = ones.scan((acc, one) => acc + one, seed); count.subscribe(x => console.log(x));

see

expand

see

mergeScan

see

reduce

method

scan

owner

Observable

Type parameters
- T
- R
Parameters
- accumulator: function
 
 The accumulator function called on each source value.
 - - (acc: R, value: T): R
 - Parameters
 - acc: R
 - value: T
 Returns R
- Optional seed: T | R
Returns Observable<R>

An observable of the accumulated values.

"node_modules/rxjs/src/operator/share"

"node_modules/rxjs/src/operator/share":

ShareSignature

__call(): Observable<T>

- Defined in node_modules/rxjs/src/operator/share.ts:25
Returns Observable<T>

share<T>(): Observable<T>

- Defined in node_modules/rxjs/src/operator/share.ts:21
Returns a new Observable that multicasts (shares) the original Observable. As long as there is at least one Subscriber this Observable will be subscribed and emitting data. When all subscribers have unsubscribed it will unsubscribe from the source Observable. Because the Observable is multicasting it makes the stream hot. This is an alias for .publish().refCount().

method

share

owner

Observable

Type parameters
- T
Returns Observable<T>

an Observable that upon connection causes the source Observable to emit items to its Observers

shareSubjectFactory

shareSubjectFactory(): Subject<Object>

- Defined in node_modules/rxjs/src/operator/share.ts:5
Returns Subject<Object>

"node_modules/rxjs/src/operator/single"

"node_modules/rxjs/src/operator/single":

SingleOperator

SingleOperator:

constructor

new SingleOperator(predicate?: function, source?: Observable<T>): SingleOperator

- Defined in node_modules/rxjs/src/operator/single.ts:31
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional source: Observable<T>
Returns SingleOperator

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

source

source: Observable<T>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/single.ts:36
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

SingleSubscriber

SingleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SingleSubscriber(destination: Observer<T>, predicate?: function, source?: Observable<T>): SingleSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/single.ts:49
Parameters
- destination: Observer<T>
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
- Optional source: Observable<T>
Returns SingleSubscriber

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

predicate

predicate: function

Type declaration

- (value: T, index: number, source: Observable<T>): boolean
- Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean

seenValue

seenValue: boolean

singleValue

singleValue: T

source

source: Observable<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/single.ts:87
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/single.ts:66
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

applySingleValue

applySingleValue(value: T): void

- Defined in node_modules/rxjs/src/operator/single.ts:57
Parameters
- value: T
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

tryNext

tryNext(value: T): void

- Defined in node_modules/rxjs/src/operator/single.ts:76
Parameters
- value: T
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SingleSignature

__call(predicate?: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/single.ts:27
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
Returns Observable<T>

single

single<T>(predicate?: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/single.ts:23
Returns an Observable that emits the single item emitted by the source Observable that matches a specified predicate, if that Observable emits one such item. If the source Observable emits more than one such item or no such items, notify of an IllegalArgumentException or NoSuchElementException respectively.

throws

{EmptyError} Delivers an EmptyError to the Observer's error callback if the Observable completes before any next notification was sent.

method

single

owner

Observable

Type parameters
- T
Parameters
- Optional predicate: function
 - - (value: T, index: number, source: Observable<T>): boolean
 - Parameters
 - value: T
 - index: number
 - source: Observable<T>
 Returns boolean
Returns Observable<T>

an Observable that emits the single item emitted by the source Observable that matches the predicate. .

"node_modules/rxjs/src/operator/skip"

"node_modules/rxjs/src/operator/skip":

SkipOperator

SkipOperator:

constructor

new SkipOperator(total: number): SkipOperator

- Defined in node_modules/rxjs/src/operator/skip.ts:24
Parameters
- total: number
Returns SkipOperator

total

total: number

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/skip.ts:28
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

SkipSubscriber

SkipSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SkipSubscriber(destination: Subscriber<T>, total: number): SkipSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/skip.ts:39
Parameters
- destination: Subscriber<T>
- total: number
Returns SkipSubscriber

count

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

total

total: number

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(x: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/skip.ts:45
Parameters
- x: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SkipSignature

__call(total: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/skip.ts:20
Parameters
- total: number
Returns Observable<T>

skip

skip<T>(total: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/skip.ts:16
Returns an Observable that skips n items emitted by an Observable.

method

skip

owner

Observable

Type parameters
- T
Parameters
- total: number
Returns Observable<T>

an Observable that skips values emitted by the source Observable.

"node_modules/rxjs/src/operator/skipUntil"

"node_modules/rxjs/src/operator/skipUntil":

SkipUntilOperator

SkipUntilOperator:

constructor

new SkipUntilOperator(notifier: Observable<any>): SkipUntilOperator

- Defined in node_modules/rxjs/src/operator/skipUntil.ts:29
Parameters
- notifier: Observable<any>
Returns SkipUntilOperator

notifier

notifier: Observable<any>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/skipUntil.ts:33
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

SkipUntilSubscriber

SkipUntilSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SkipUntilSubscriber(destination: Subscriber<any>, notifier: Observable<any>): SkipUntilSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/skipUntil.ts:46
Parameters
- destination: Subscriber<any>
- notifier: Observable<any>
Returns SkipUntilSubscriber

destination

destination: PartialObserver

hasValue

hasValue: boolean

isInnerStopped

isInnerStopped: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/skipUntil.ts:60
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/skipUntil.ts:54
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/skipUntil.ts:74
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/skipUntil.ts:68
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SkipUntilSignature

__call(notifier: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/skipUntil.ts:25
Parameters
- notifier: Observable<any>
Returns Observable<T>

skipUntil

skipUntil<T>(notifier: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/skipUntil.ts:21
Returns an Observable that skips items emitted by the source Observable until a second Observable emits an item.

method

skipUntil

owner

Observable

Type parameters
- T
Parameters
- notifier: Observable<any>
Returns Observable<T>

an Observable that skips items from the source Observable until the second Observable emits an item, then emits the remaining items.

"node_modules/rxjs/src/operator/skipWhile"

"node_modules/rxjs/src/operator/skipWhile":

SkipWhileOperator

SkipWhileOperator:

constructor

new SkipWhileOperator(predicate: function): SkipWhileOperator

- Defined in node_modules/rxjs/src/operator/skipWhile.ts:25
Parameters
- predicate: function
  - - (value: T, index: number): boolean
    - Parameters
      - value: T
      - index: number
      Returns boolean
Returns SkipWhileOperator

predicate

predicate: function

Type declaration

- (value: T, index: number): boolean
- Parameters
  - value: T
  - index: number
  Returns boolean

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/skipWhile.ts:29
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

SkipWhileSubscriber

SkipWhileSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SkipWhileSubscriber(destination: Subscriber<T>, predicate: function): SkipWhileSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/skipWhile.ts:41
Parameters
- destination: Subscriber<T>
- predicate: function
 - - (value: T, index: number): boolean
 - Parameters
 - value: T
 - index: number
 Returns boolean
Returns SkipWhileSubscriber

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

predicate

predicate: function

Type declaration

- (value: T, index: number): boolean
- Parameters
  - value: T
  - index: number
  Returns boolean

skipping

skipping: boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/skipWhile.ts:48
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

tryCallPredicate

tryCallPredicate(value: T): void

- Defined in node_modules/rxjs/src/operator/skipWhile.ts:59
Parameters
- value: T
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SkipWhileSignature

__call(predicate: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/skipWhile.ts:21
Parameters
- predicate: function
 - - (value: T, index: number): boolean
 - Parameters
 - value: T
 - index: number
 Returns boolean
Returns Observable<T>

skipWhile

skipWhile<T>(predicate: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/skipWhile.ts:17
Returns an Observable that skips all items emitted by the source Observable as long as a specified condition holds true, but emits all further source items as soon as the condition becomes false.

method

skipWhile

owner

Observable

Type parameters
- T
Parameters
- predicate: function
 
 a function to test each item emitted from the source Observable.
 - - (value: T, index: number): boolean
 - Parameters
 - value: T
 - index: number
 Returns boolean
Returns Observable<T>

an Observable that begins emitting items emitted by the source Observable when the specified predicate becomes false.

"node_modules/rxjs/src/operator/startWith"

"node_modules/rxjs/src/operator/startWith":

StartWithSignature

__call(v1: T, scheduler?: Scheduler): Observable<T>
__call(v1: T, v2: T, scheduler?: Scheduler): Observable<T>
__call(v1: T, v2: T, v3: T, scheduler?: Scheduler): Observable<T>
__call(v1: T, v2: T, v3: T, v4: T, scheduler?: Scheduler): Observable<T>
__call(v1: T, v2: T, v3: T, v4: T, v5: T, scheduler?: Scheduler): Observable<T>
__call(v1: T, v2: T, v3: T, v4: T, v5: T, v6: T, scheduler?: Scheduler): Observable<T>
__call(...array: Array<T | Scheduler>): Observable<T>

- Defined in node_modules/rxjs/src/operator/startWith.ts:39
Parameters
- v1: T
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/startWith.ts:40
Parameters
- v1: T
- v2: T
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/startWith.ts:41
Parameters
- v1: T
- v2: T
- v3: T
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/startWith.ts:42
Parameters
- v1: T
- v2: T
- v3: T
- v4: T
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/startWith.ts:43
Parameters
- v1: T
- v2: T
- v3: T
- v4: T
- v5: T
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/startWith.ts:44
Parameters
- v1: T
- v2: T
- v3: T
- v4: T
- v5: T
- v6: T
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/startWith.ts:45
Parameters
- Rest ...array: Array<T | Scheduler>
Returns Observable<T>

startWith

startWith<T>(...array: Array<T | Scheduler>): Observable<T>

- Defined in node_modules/rxjs/src/operator/startWith.ts:21
Returns an Observable that emits the items in a specified Iterable before it begins to emit items emitted by the source Observable.

method

startWith

owner

Observable

Type parameters
- T
Parameters
- Rest ...array: Array<T | Scheduler>
Returns Observable<T>

an Observable that emits the items in the specified Iterable and then emits the items emitted by the source Observable.

"node_modules/rxjs/src/operator/subscribeOn"

"node_modules/rxjs/src/operator/subscribeOn":

SubscribeOnSignature

__call(scheduler: Scheduler, delay?: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/subscribeOn.ts:20
Parameters
- scheduler: Scheduler
- Optional delay: number
Returns Observable<T>

subscribeOn

subscribeOn<T>(scheduler: Scheduler, delay?: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/subscribeOn.ts:16
Asynchronously subscribes Observers to this Observable on the specified Scheduler.

method

subscribeOn

owner

Observable

Type parameters
- T
Parameters
- scheduler: Scheduler
- Default value delay: number = 0
Returns Observable<T>

the source Observable modified so that its subscriptions happen on the specified Scheduler .

"node_modules/rxjs/src/operator/switch"

"node_modules/rxjs/src/operator/switch":

SwitchOperator

SwitchOperator:

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/switch.ts:59
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

SwitchSubscriber

SwitchSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SwitchSubscriber(destination: Subscriber<R>): SwitchSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/switch.ts:72
Parameters
- destination: Subscriber<R>
Returns SwitchSubscriber

active

active: number

destination

destination: PartialObserver

hasCompleted

hasCompleted: boolean

innerSubscription

innerSubscription: Subscription

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/switch.ts:84
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/switch.ts:78
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/switch.ts:110
Returns void

notifyError

notifyError(err: any): void

Overwrites OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/operator/switch.ts:106
Parameters
- err: any
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/switch.ts:100
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

unsubscribeInner

unsubscribeInner(): void

- Defined in node_modules/rxjs/src/operator/switch.ts:91
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchSignature

__call(): T

- Defined in node_modules/rxjs/src/operator/switch.ts:54
Returns T

_switch

_switch<T>(): T

- Defined in node_modules/rxjs/src/operator/switch.ts:50
Converts a higher-order Observable into a first-order Observable by subscribing to only the most recently emitted of those inner Observables.

Flattens an Observable-of-Observables by dropping the previous inner Observable once a new one appears.

switch subscribes to an Observable that emits Observables, also known as a higher-order Observable. Each time it observes one of these emitted inner Observables, the output Observable subscribes to the inner Observable and begins emitting the items emitted by that. So far, it behaves like mergeAll. However, when a new inner Observable is emitted, switch unsubscribes from the earlier-emitted inner Observable and subscribes to the new inner Observable and begins emitting items from it. It continues to behave like this for subsequent inner Observables.

example

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); // Each click event is mapped to an Observable that ticks every second var higherOrder = clicks.map((ev) => Rx.Observable.interval(1000)); var switched = higherOrder.switch(); // The outcome is that switched is essentially a timer that restarts // on every click. The interval Observables from older clicks do not merge // with the current interval Observable. switched.subscribe(x => console.log(x));

see

combineAll

see

concatAll

see

exhaust

see

mergeAll

see

switchMap

see

switchMapTo

see

zipAll

method

switch

name

switch

owner

Observable

Type parameters
- T
Returns T

An Observable that emits the items emitted by the Observable most recently emitted by the source Observable.

"node_modules/rxjs/src/operator/switchMap"

"node_modules/rxjs/src/operator/switchMap":

SwitchMapOperator

SwitchMapOperator:

constructor

new SwitchMapOperator(project: function, resultSelector?: function): SwitchMapOperator

- Defined in node_modules/rxjs/src/operator/switchMap.ts:67
Parameters
- project: function
  - - (value: T, index: number): ObservableInput
    - Parameters
      - value: T
      - index: number
      Returns ObservableInput
- Optional resultSelector: function
  - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
    - Parameters
      - outerValue: T
      - innerValue: I
      - outerIndex: number
      - innerIndex: number
      Returns R
Returns SwitchMapOperator

project

project: function

Type declaration

- (value: T, index: number): ObservableInput
- Parameters
  - value: T
  - index: number
  Returns ObservableInput

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

call

call(subscriber: Subscriber, source: any): any

- Defined in node_modules/rxjs/src/operator/switchMap.ts:72
Parameters
- subscriber: Subscriber
- source: any
Returns any

SwitchMapSubscriber

SwitchMapSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SwitchMapSubscriber(destination: Subscriber, project: function, resultSelector?: function): SwitchMapSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/switchMap.ts:84
Parameters
- destination: Subscriber
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns SwitchMapSubscriber

destination

destination: PartialObserver

index

index: number

innerSubscription

innerSubscription: Subscription

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

project

project: function

Type declaration

- (value: T, index: number): ObservableInput
- Parameters
  - value: T
  - index: number
  Returns ObservableInput

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/switchMap.ts:112
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_innerSub

_innerSub(result: any, value: T, index: number): void

- Defined in node_modules/rxjs/src/operator/switchMap.ts:104
Parameters
- result: any
- value: T
- index: number
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/switchMap.ts:92
Parameters
- value: T
Returns void

_tryNotifyNext

_tryNotifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

- Defined in node_modules/rxjs/src/operator/switchMap.ts:141
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
Returns void

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/operator/switchMap.ts:119
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/switchMap.ts:123
Parameters
- innerSub: Subscription
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, I>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, I>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/switchMap.ts:131
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, I>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchMapSignature

__call<R>(project: function): Observable<R>
__call<I, R>(project: function, resultSelector: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/switchMap.ts:61
Type parameters
- R
Parameters
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/switchMap.ts:62
Type parameters
- I
- R
Parameters
- project: function
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns Observable<R>

switchMap

switchMap<T, I, R>(project: function, resultSelector?: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/switchMap.ts:56
Projects each source value to an Observable which is merged in the output Observable, emitting values only from the most recently projected Observable.

Maps each value to an Observable, then flattens all of these inner Observables using switch.

Returns an Observable that emits items based on applying a function that you supply to each item emitted by the source Observable, where that function returns an (so-called "inner") Observable. Each time it observes one of these inner Observables, the output Observable begins emitting the items emitted by that inner Observable. When a new inner Observable is emitted, switchMap stops emitting items from the earlier-emitted inner Observable and begins emitting items from the new one. It continues to behave like this for subsequent inner Observables.

example

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMap((ev) => Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

see

concatMap

see

exhaustMap

see

mergeMap

see

switch

see

switchMapTo

method

switchMap

owner

Observable

Type parameters
- T
- I
- R
Parameters
- project: function
 
 A function that, when applied to an item emitted by the source Observable, returns an Observable.
 - - (value: T, index: number): ObservableInput
 - Parameters
 - value: T
 - index: number
 Returns ObservableInput
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns Observable<R>

An Observable that emits the result of applying the projection function (and the optional resultSelector) to each item emitted by the source Observable and taking only the values from the most recently projected inner Observable.

"node_modules/rxjs/src/operator/switchMapTo"

"node_modules/rxjs/src/operator/switchMapTo":

SwitchMapToOperator

SwitchMapToOperator:

constructor

new SwitchMapToOperator(observable: Observable, resultSelector?: function): SwitchMapToOperator

- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:67
Parameters
- observable: Observable
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns SwitchMapToOperator

observable

observable: Observable

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

call

call(subscriber: Subscriber, source: any): any

- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:72
Parameters
- subscriber: Subscriber
- source: any
Returns any

SwitchMapToSubscriber

SwitchMapToSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new SwitchMapToSubscriber(destination: Subscriber, inner: Observable, resultSelector?: function): SwitchMapToSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:84
Parameters
- destination: Subscriber
- inner: Observable
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns SwitchMapToSubscriber

destination

destination: PartialObserver

index

index: number

inner

inner: Observable

innerSubscription

innerSubscription: Subscription

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

resultSelector

resultSelector: function

Type declaration

- (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
- Parameters
  - outerValue: T
  - innerValue: I
  - outerIndex: number
  - innerIndex: number
  Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:100
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: any): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:92
Parameters
- value: any
Returns void

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:107
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:111
Parameters
- innerSub: Subscription
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, I>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, I>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, I>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:119
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, I>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

tryResultSelector

tryResultSelector(outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): void

- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:130
Parameters
- outerValue: T
- innerValue: I
- outerIndex: number
- innerIndex: number
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

SwitchMapToSignature

__call<R>(observable: ObservableInput): Observable<R>
__call<I, R>(observable: ObservableInput, resultSelector: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:61
Type parameters
- R
Parameters
- observable: ObservableInput
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:62
Type parameters
- I
- R
Parameters
- observable: ObservableInput
- resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns Observable<R>

switchMapTo

switchMapTo<T, I, R>(innerObservable: Observable, resultSelector?: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/switchMapTo.ts:53
Projects each source value to the same Observable which is flattened multiple times with switch in the output Observable.

It's like switchMap, but maps each value always to the same inner Observable.

Maps each source value to the given Observable innerObservable regardless of the source value, and then flattens those resulting Observables into one single Observable, which is the output Observable. The output Observables emits values only from the most recently emitted instance of innerObservable.

example

Rerun an interval Observable on every click event var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.switchMapTo(Rx.Observable.interval(1000)); result.subscribe(x => console.log(x));

see

concatMapTo

see

switch

see

switchMap

see

mergeMapTo

method

switchMapTo

owner

Observable

Type parameters
- T
- I
- R
Parameters
- innerObservable: Observable
 
 An Observable to replace each value from the source Observable.
- Optional resultSelector: function
 - - (outerValue: T, innerValue: I, outerIndex: number, innerIndex: number): R
 - Parameters
 - outerValue: T
 - innerValue: I
 - outerIndex: number
 - innerIndex: number
 Returns R
Returns Observable<R>

An Observable that emits items from the given innerObservable every time a value is emitted on the source Observable.

"node_modules/rxjs/src/operator/take"

"node_modules/rxjs/src/operator/take":

TakeOperator

TakeOperator:

constructor

new TakeOperator(total: number): TakeOperator

- Defined in node_modules/rxjs/src/operator/take.ts:27
Parameters
- total: number
Returns TakeOperator

total

total: number

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/take.ts:34
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

TakeSubscriber

TakeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new TakeSubscriber(destination: Subscriber<T>, total: number): TakeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/take.ts:45
Parameters
- destination: Subscriber<T>
- total: number
Returns TakeSubscriber

count

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

total

total: number

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/take.ts:51
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TakeSignature

__call(total: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/take.ts:23
Parameters
- total: number
Returns Observable<T>

take

take<T>(total: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/take.ts:15
throws

{ArgumentOutOfRangeError} When using take(i), it delivers an ArgumentOutOrRangeError to the Observer's error callback if i < 0.

method

take

owner

Observable

Type parameters
- T
Parameters
- total: number
Returns Observable<T>

"node_modules/rxjs/src/operator/takeLast"

"node_modules/rxjs/src/operator/takeLast":

TakeLastOperator

TakeLastOperator:

constructor

new TakeLastOperator(total: number): TakeLastOperator

- Defined in node_modules/rxjs/src/operator/takeLast.ts:27
Parameters
- total: number
Returns TakeLastOperator

total

total: number

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/takeLast.ts:34
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

TakeLastSubscriber

TakeLastSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new TakeLastSubscriber(destination: Subscriber<T>, total: number): TakeLastSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/takeLast.ts:46
Parameters
- destination: Subscriber<T>
- total: number
Returns TakeLastSubscriber

count

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

ring

ring: Array<T>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

total

total: number

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/takeLast.ts:65
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/takeLast.ts:52
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TakeLastSignature

__call(total: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/takeLast.ts:23
Parameters
- total: number
Returns Observable<T>

takeLast

takeLast<T>(total: number): Observable<T>

- Defined in node_modules/rxjs/src/operator/takeLast.ts:15
throws

{ArgumentOutOfRangeError} When using takeLast(i), it delivers an ArgumentOutOrRangeError to the Observer's error callback if i < 0.

method

takeLast

owner

Observable

Type parameters
- T
Parameters
- total: number
Returns Observable<T>

"node_modules/rxjs/src/operator/takeUntil"

"node_modules/rxjs/src/operator/takeUntil":

TakeUntilOperator

TakeUntilOperator:

constructor

new TakeUntilOperator(notifier: Observable<any>): TakeUntilOperator

- Defined in node_modules/rxjs/src/operator/takeUntil.ts:23
Parameters
- notifier: Observable<any>
Returns TakeUntilOperator

notifier

notifier: Observable<any>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/takeUntil.ts:27
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

TakeUntilSubscriber

TakeUntilSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new TakeUntilSubscriber(destination: Subscriber<any>, notifier: Observable<any>): TakeUntilSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/takeUntil.ts:37
Parameters
- destination: Subscriber<any>
- notifier: Observable<any>
Returns TakeUntilSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

notifier

notifier: Observable<any>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/takeUntil.ts:51
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/takeUntil.ts:45
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TakeUntilSignature

__call(notifier: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/takeUntil.ts:19
Parameters
- notifier: Observable<any>
Returns Observable<T>

takeUntil

takeUntil<T>(notifier: Observable<any>): Observable<T>

- Defined in node_modules/rxjs/src/operator/takeUntil.ts:15
method

takeUntil

owner

Observable

Type parameters
- T
Parameters
- notifier: Observable<any>
Returns Observable<T>

"node_modules/rxjs/src/operator/takeWhile"

"node_modules/rxjs/src/operator/takeWhile":

TakeWhileOperator

TakeWhileOperator:

constructor

new TakeWhileOperator(predicate: function): TakeWhileOperator

- Defined in node_modules/rxjs/src/operator/takeWhile.ts:19
Parameters
- predicate: function
  - - (value: T, index: number): boolean
    - Parameters
      - value: T
      - index: number
      Returns boolean
Returns TakeWhileOperator

predicate

predicate: function

Type declaration

- (value: T, index: number): boolean
- Parameters
  - value: T
  - index: number
  Returns boolean

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/takeWhile.ts:23
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

TakeWhileSubscriber

TakeWhileSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new TakeWhileSubscriber(destination: Subscriber<T>, predicate: function): TakeWhileSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/takeWhile.ts:34
Parameters
- destination: Subscriber<T>
- predicate: function
 - - (value: T, index: number): boolean
 - Parameters
 - value: T
 - index: number
 Returns boolean
Returns TakeWhileSubscriber

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

predicate

predicate: function

Type declaration

- (value: T, index: number): boolean
- Parameters
  - value: T
  - index: number
  Returns boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/takeWhile.ts:41
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

nextOrComplete

nextOrComplete(value: T, predicateResult: boolean): void

- Defined in node_modules/rxjs/src/operator/takeWhile.ts:53
Parameters
- value: T
- predicateResult: boolean
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TakeWhileSignature

__call(predicate: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/takeWhile.ts:15
Parameters
- predicate: function
 - - (value: T, index: number): boolean
 - Parameters
 - value: T
 - index: number
 Returns boolean
Returns Observable<T>

takeWhile

takeWhile<T>(predicate: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/takeWhile.ts:11
method

takeWhile

owner

Observable

Type parameters
- T
Parameters
- predicate: function
 - - (value: T, index: number): boolean
 - Parameters
 - value: T
 - index: number
 Returns boolean
Returns Observable<T>

"node_modules/rxjs/src/operator/throttle"

"node_modules/rxjs/src/operator/throttle":

ThrottleOperator

ThrottleOperator:

constructor

new ThrottleOperator(durationSelector: function): ThrottleOperator

- Defined in node_modules/rxjs/src/operator/throttle.ts:24
Parameters
- durationSelector: function
  - - (value: T): SubscribableOrPromise
    - Parameters
      - value: T
      Returns SubscribableOrPromise
Returns ThrottleOperator

durationSelector

durationSelector: function

Type declaration

- (value: T): SubscribableOrPromise
- Parameters
  - value: T
  Returns SubscribableOrPromise

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/throttle.ts:28
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

ThrottleSubscriber

ThrottleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ThrottleSubscriber(destination: Subscriber<T>, durationSelector: function): ThrottleSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/throttle.ts:39
Parameters
- destination: Subscriber<T>
- durationSelector: function
 - - (value: T): SubscribableOrPromise
 - Parameters
 - value: T
 Returns SubscribableOrPromise
Returns ThrottleSubscriber

destination

destination: Subscriber<T>

durationSelector

durationSelector: function

Type declaration

- (value: T): SubscribableOrPromise
- Parameters
  - value: T
  Returns SubscribableOrPromise

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

throttled

throttled: Subscription

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/throttle.ts:46
Parameters
- value: T
Returns void

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/operator/throttle.ts:68
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

emitAndThrottle

emitAndThrottle(value: T, duration: SubscribableOrPromise): void

- Defined in node_modules/rxjs/src/operator/throttle.ts:63
Parameters
- value: T
- duration: SubscribableOrPromise
Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/throttle.ts:83
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/throttle.ts:77
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

tryDurationSelector

tryDurationSelector(value: T): void

- Defined in node_modules/rxjs/src/operator/throttle.ts:52
Parameters
- value: T
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ThrottleSignature

__call(durationSelector: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/throttle.ts:20
Parameters
- durationSelector: function
 - - (value: T): SubscribableOrPromise
 - Parameters
 - value: T
 Returns SubscribableOrPromise
Returns Observable<T>

throttle

throttle<T>(durationSelector: function): Observable<T>

- Defined in node_modules/rxjs/src/operator/throttle.ts:16
method

throttle

owner

Observable

Type parameters
- T
Parameters
- durationSelector: function
 - - (value: T): SubscribableOrPromise
 - Parameters
 - value: T
 Returns SubscribableOrPromise
Returns Observable<T>

"node_modules/rxjs/src/operator/throttleTime"

"node_modules/rxjs/src/operator/throttleTime":

ThrottleTimeOperator

ThrottleTimeOperator:

constructor

new ThrottleTimeOperator(delay: number, scheduler: Scheduler): ThrottleTimeOperator

- Defined in node_modules/rxjs/src/operator/throttleTime.ts:23
Parameters
- delay: number
- scheduler: Scheduler
Returns ThrottleTimeOperator

delay

delay: number

scheduler

scheduler: Scheduler

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/throttleTime.ts:27
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

ThrottleTimeSubscriber

ThrottleTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ThrottleTimeSubscriber(destination: Subscriber<T>, delay: number, scheduler: Scheduler): ThrottleTimeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/throttleTime.ts:38
Parameters
- destination: Subscriber<T>
- delay: number
- scheduler: Scheduler
Returns ThrottleTimeSubscriber

delay

delay: number

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

throttled

throttled: Subscription

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/throttleTime.ts:46
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

clearThrottle

clearThrottle(): void

- Defined in node_modules/rxjs/src/operator/throttleTime.ts:53
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

DispatchArg

DispatchArg:

subscriber

subscriber: ThrottleTimeSubscriber<T>

ThrottleTimeSignature

__call(dueTime: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/throttleTime.ts:19
Parameters
- dueTime: number
- Optional scheduler: Scheduler
Returns Observable<T>

dispatchNext

dispatchNext<T>(arg: DispatchArg<T>): void

- Defined in node_modules/rxjs/src/operator/throttleTime.ts:67
Type parameters
- T
Parameters
- arg: DispatchArg<T>
Returns void

throttleTime

throttleTime<T>(delay: number, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/throttleTime.ts:15
method

throttleTime

owner

Observable

Type parameters
- T
Parameters
- delay: number
- Default value scheduler: Scheduler = async
Returns Observable<T>

"node_modules/rxjs/src/operator/timeInterval"

"node_modules/rxjs/src/operator/timeInterval":

TimeInterval

TimeInterval:

constructor

new TimeInterval(value: T, interval: number): TimeInterval

- Defined in node_modules/rxjs/src/operator/timeInterval.ts:21
Parameters
- value: T
- interval: number
Returns TimeInterval

interval

interval: number

value

value: T

TimeIntervalOperator

TimeIntervalOperator:

constructor

new TimeIntervalOperator(scheduler: Scheduler): TimeIntervalOperator

- Defined in node_modules/rxjs/src/operator/timeInterval.ts:27
Parameters
- scheduler: Scheduler
Returns TimeIntervalOperator

scheduler

scheduler: Scheduler

call

call(observer: Subscriber<TimeInterval<T>>, source: any): any

- Defined in node_modules/rxjs/src/operator/timeInterval.ts:32
Parameters
- observer: Subscriber<TimeInterval<T>>
- source: any
Returns any

TimeIntervalSubscriber

TimeIntervalSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new TimeIntervalSubscriber(destination: Subscriber<TimeInterval<T>>, scheduler: Scheduler): TimeIntervalSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/timeInterval.ts:43
Parameters
- destination: Subscriber<TimeInterval<T>>
- scheduler: Scheduler
Returns TimeIntervalSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

lastTime

lastTime: number

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/timeInterval.ts:51
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TimeIntervalSignature

__call(scheduler?: Scheduler): Observable<TimeInterval<T>>

- Defined in node_modules/rxjs/src/operator/timeInterval.ts:17
Parameters
- Optional scheduler: Scheduler
Returns Observable<TimeInterval<T>>

timeInterval

timeInterval<T>(scheduler?: Scheduler): Observable<TimeInterval<T>>

- Defined in node_modules/rxjs/src/operator/timeInterval.ts:13
method

timeInterval

owner

Observable

Type parameters
- T
Parameters
- Default value scheduler: Scheduler = async
Returns Observable<TimeInterval<T>>

"node_modules/rxjs/src/operator/timeout"

"node_modules/rxjs/src/operator/timeout":

TimeoutOperator

TimeoutOperator:

constructor

new TimeoutOperator(waitFor: number, absoluteTimeout: boolean, errorToSend: any, scheduler: Scheduler): TimeoutOperator

- Defined in node_modules/rxjs/src/operator/timeout.ts:28
Parameters
- waitFor: number
- absoluteTimeout: boolean
- errorToSend: any
- scheduler: Scheduler
Returns TimeoutOperator

absoluteTimeout

absoluteTimeout: boolean

errorToSend

errorToSend: any

scheduler

scheduler: Scheduler

waitFor

waitFor: number

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/timeout.ts:35
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

TimeoutSubscriber

TimeoutSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new TimeoutSubscriber(destination: Subscriber<T>, absoluteTimeout: boolean, waitFor: number, errorToSend: any, scheduler: Scheduler): TimeoutSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/timeout.ts:56
Parameters
- destination: Subscriber<T>
- absoluteTimeout: boolean
- waitFor: number
- errorToSend: any
- scheduler: Scheduler
Returns TimeoutSubscriber

_hasCompleted

_hasCompleted: boolean

_previousIndex

_previousIndex: number

absoluteTimeout

absoluteTimeout: boolean

destination

destination: PartialObserver

errorToSend

errorToSend: any

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

waitFor

waitFor: number

EMPTY

EMPTY: Subscription

hasCompleted

hasCompleted:

previousIndex

previousIndex:

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/timeout.ts:95
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/timeout.ts:90
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/timeout.ts:82
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyTimeout

notifyTimeout(): void

- Defined in node_modules/rxjs/src/operator/timeout.ts:100
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

scheduleTimeout

scheduleTimeout(): void

- Defined in node_modules/rxjs/src/operator/timeout.ts:75
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatchTimeout

dispatchTimeout(state: any): void

- Defined in node_modules/rxjs/src/operator/timeout.ts:67
Parameters
- state: any
Returns void

TimeoutSignature

__call(due: number | Date, errorToSend?: any, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/timeout.ts:24
Parameters
- due: number | Date
- Optional errorToSend: any
- Optional scheduler: Scheduler
Returns Observable<T>

timeout

timeout<T>(due: number | Date, errorToSend?: any, scheduler?: Scheduler): Observable<T>

- Defined in node_modules/rxjs/src/operator/timeout.ts:16
method

timeout

owner

Observable

Type parameters
- T
Parameters
- due: number | Date
- Default value errorToSend: any = null
- Default value scheduler: Scheduler = async
Returns Observable<T>

"node_modules/rxjs/src/operator/timeoutWith"

"node_modules/rxjs/src/operator/timeoutWith":

TimeoutWithOperator

TimeoutWithOperator:

constructor

new TimeoutWithOperator(waitFor: number, absoluteTimeout: boolean, withObservable: Observable<any>, scheduler: Scheduler): TimeoutWithOperator

- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:32
Parameters
- waitFor: number
- absoluteTimeout: boolean
- withObservable: Observable<any>
- scheduler: Scheduler
Returns TimeoutWithOperator

absoluteTimeout

absoluteTimeout: boolean

scheduler

scheduler: Scheduler

waitFor

waitFor: number

withObservable

withObservable: Observable<any>

call

call(subscriber: Subscriber<T>, source: any): any

- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:39
Parameters
- subscriber: Subscriber<T>
- source: any
Returns any

TimeoutWithSubscriber

TimeoutWithSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new TimeoutWithSubscriber(destination: Subscriber<T>, absoluteTimeout: boolean, waitFor: number, withObservable: Observable<any>, scheduler: Scheduler): TimeoutWithSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:61
Parameters
- destination: Subscriber<T>
- absoluteTimeout: boolean
- waitFor: number
- withObservable: Observable<any>
- scheduler: Scheduler
Returns TimeoutWithSubscriber

_hasCompleted

_hasCompleted: boolean

_previousIndex

_previousIndex: number

absoluteTimeout

absoluteTimeout: boolean

destination

destination: Subscriber<T>

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

timeoutSubscription

timeoutSubscription: Subscription

waitFor

waitFor: number

withObservable

withObservable: Observable<any>

EMPTY

EMPTY: Subscription

hasCompleted

hasCompleted:

previousIndex

previousIndex:

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:101
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:96
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:89
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

handleTimeout

handleTimeout(): void

- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:106
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:20
Parameters
- innerSub: InnerSubscriber<T, R>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:10
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

scheduleTimeout

scheduleTimeout(): void

- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:81
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

dispatchTimeout

dispatchTimeout(state: any): void

- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:73
Parameters
- state: any
Returns void

TimeoutWithSignature

__call(due: number | Date, withObservable: Observable<T>, scheduler?: Scheduler): Observable<T>
__call<R>(due: number | Date, withObservable: Observable<R>, scheduler?: Scheduler): Observable<T | R>

- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:27
Parameters
- due: number | Date
- withObservable: Observable<T>
- Optional scheduler: Scheduler
Returns Observable<T>
- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:28
Type parameters
- R
Parameters
- due: number | Date
- withObservable: Observable<R>
- Optional scheduler: Scheduler
Returns Observable<T | R>

timeoutWith

timeoutWith<T, R>(due: number | Date, withObservable: Observable<R>, scheduler?: Scheduler): Observable<T | R>

- Defined in node_modules/rxjs/src/operator/timeoutWith.ts:19
method

timeoutWith

owner

Observable

Type parameters
- T
- R
Parameters
- due: number | Date
- withObservable: Observable<R>
- Default value scheduler: Scheduler = async
Returns Observable<T | R>

"node_modules/rxjs/src/operator/timestamp"

"node_modules/rxjs/src/operator/timestamp":

Timestamp

Timestamp:

constructor

new Timestamp(value: T, timestamp: number): Timestamp

- Defined in node_modules/rxjs/src/operator/timestamp.ts:21
Parameters
- value: T
- timestamp: number
Returns Timestamp

timestamp

timestamp: number

value

value: T

TimestampOperator

TimestampOperator:

constructor

new TimestampOperator(scheduler: Scheduler): TimestampOperator

- Defined in node_modules/rxjs/src/operator/timestamp.ts:26
Parameters
- scheduler: Scheduler
Returns TimestampOperator

scheduler

scheduler: Scheduler

call

call(observer: Subscriber<Timestamp<T>>, source: any): any

- Defined in node_modules/rxjs/src/operator/timestamp.ts:30
Parameters
- observer: Subscriber<Timestamp<T>>
- source: any
Returns any

TimestampSubscriber

TimestampSubscriber:

constructor

new TimestampSubscriber(destination: Subscriber<Timestamp<T>>, scheduler: Scheduler): TimestampSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/timestamp.ts:35
Parameters
- destination: Subscriber<Timestamp<T>>
- scheduler: Scheduler
Returns TimestampSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/timestamp.ts:40
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

TimestampSignature

__call(scheduler?: Scheduler): Observable<Timestamp<T>>

- Defined in node_modules/rxjs/src/operator/timestamp.ts:17
Parameters
- Optional scheduler: Scheduler
Returns Observable<Timestamp<T>>

timestamp

timestamp<T>(scheduler?: Scheduler): Observable<Timestamp<T>>

- Defined in node_modules/rxjs/src/operator/timestamp.ts:13
method

timestamp

owner

Observable

Type parameters
- T
Parameters
- Default value scheduler: Scheduler = async
Returns Observable<Timestamp<T>>

"node_modules/rxjs/src/operator/toArray"

"node_modules/rxjs/src/operator/toArray":

ToArrayOperator

ToArrayOperator:

call

call(subscriber: Subscriber<T[]>, source: any): any

- Defined in node_modules/rxjs/src/operator/toArray.ts:19
Parameters
- subscriber: Subscriber<T[]>
- source: any
Returns any

ToArraySubscriber

ToArraySubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ToArraySubscriber(destination: Subscriber<T[]>): ToArraySubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/toArray.ts:31
Parameters
- destination: Subscriber<T[]>
Returns ToArraySubscriber

array

array: T[]

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/toArray.ts:41
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(x: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/toArray.ts:37
Parameters
- x: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ToArraySignature

__call(): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/toArray.ts:14
Returns Observable<T[]>

toArray

toArray<T>(): Observable<T[]>

- Defined in node_modules/rxjs/src/operator/toArray.ts:10
method

toArray

owner

Observable

Type parameters
- T
Returns Observable<T[]>

"node_modules/rxjs/src/operator/toPromise"

"node_modules/rxjs/src/operator/toPromise":

ToPromiseSignature

__call(): Promise<T>
__call(PromiseCtor: PromiseConstructor): Promise<T>

- Defined in node_modules/rxjs/src/operator/toPromise.ts:28
Returns Promise<T>
- Defined in node_modules/rxjs/src/operator/toPromise.ts:29
Parameters
- PromiseCtor: PromiseConstructor
Returns Promise<T>

toPromise

toPromise<T>(PromiseCtor?: PromiseConstructor): Promise<T>

- Defined in node_modules/rxjs/src/operator/toPromise.ts:9
method

toPromise

owner

Observable

Type parameters
- T
Parameters
- Optional PromiseCtor: PromiseConstructor
Returns Promise<T>

"node_modules/rxjs/src/operator/window"

"node_modules/rxjs/src/operator/window":

WindowOperator

WindowOperator:

constructor

new WindowOperator(windowBoundaries: Observable<any>): WindowOperator

- Defined in node_modules/rxjs/src/operator/window.ts:54
Parameters
- windowBoundaries: Observable<any>
Returns WindowOperator

windowBoundaries

windowBoundaries: Observable<any>

call

call(subscriber: Subscriber<Observable<T>>, source: any): any

- Defined in node_modules/rxjs/src/operator/window.ts:59
Parameters
- subscriber: Subscriber<Observable<T>>
- source: any
Returns any

WindowSubscriber

WindowSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new WindowSubscriber(destination: Subscriber<Observable<T>>, windowBoundaries: Observable<any>): WindowSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/window.ts:70
Parameters
- destination: Subscriber<Observable<T>>
- windowBoundaries: Observable<any>
Returns WindowSubscriber

destination

destination: Subscriber<Observable<T>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

window

window: Subject<T>

windowBoundaries

windowBoundaries: Observable<any>

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/window.ts:102
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/window.ts:97
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/window.ts:93
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, any>): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/window.ts:89
Parameters
- innerSub: InnerSubscriber<T, any>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, any>): void

Overwrites OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/operator/window.ts:85
Parameters
- error: any
- innerSub: InnerSubscriber<T, any>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/window.ts:79
Parameters
- outerValue: T
- innerValue: any
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, any>
Returns void

openWindow

openWindow(): void

- Defined in node_modules/rxjs/src/operator/window.ts:107
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WindowSignature

__call(windowBoundaries: Observable<any>): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/window.ts:50
Parameters
- windowBoundaries: Observable<any>
Returns Observable<Observable<T>>

window

window<T>(windowBoundaries: Observable<any>): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/window.ts:46
Branch out the source Observable values as a nested Observable whenever windowBoundaries emits.

It's like buffer, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable windowBoundaries emits an item. Because each window is an Observable, the output is a higher-order Observable.

example

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var interval = Rx.Observable.interval(1000); var result = clicks.window(interval) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

see

windowCount

see

{@link windowTime}

see

windowToggle

see

windowWhen

see

buffer

method

window

owner

Observable

Type parameters
- T
Parameters
- windowBoundaries: Observable<any>
 
 An Observable that completes the previous window and starts a new window.
Returns Observable<Observable<T>>

An Observable of windows, which are Observables emitting values of the source Observable.

"node_modules/rxjs/src/operator/windowCount"

"node_modules/rxjs/src/operator/windowCount":

WindowCountOperator

WindowCountOperator:

constructor

new WindowCountOperator(windowSize: number, startWindowEvery: number): WindowCountOperator

- Defined in node_modules/rxjs/src/operator/windowCount.ts:63
Parameters
- windowSize: number
- startWindowEvery: number
Returns WindowCountOperator

startWindowEvery

startWindowEvery: number

windowSize

windowSize: number

call

call(subscriber: Subscriber<Observable<T>>, source: any): any

- Defined in node_modules/rxjs/src/operator/windowCount.ts:69
Parameters
- subscriber: Subscriber<Observable<T>>
- source: any
Returns any

WindowCountSubscriber

WindowCountSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new WindowCountSubscriber(destination: Subscriber<Observable<T>>, windowSize: number, startWindowEvery: number): WindowCountSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/windowCount.ts:81
Parameters
- destination: Subscriber<Observable<T>>
- windowSize: number
- startWindowEvery: number
Returns WindowCountSubscriber

count

destination

destination: Subscriber<Observable<T>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

startWindowEvery

startWindowEvery: number

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

windowSize

windowSize: number

windows

windows: Subject<T>[]

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/windowCount.ts:122
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/windowCount.ts:114
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/windowCount.ts:92
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WindowCountSignature

__call(windowSize: number, startWindowEvery?: number): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/windowCount.ts:59
Parameters
- windowSize: number
- Optional startWindowEvery: number
Returns Observable<Observable<T>>

windowCount

windowCount<T>(windowSize: number, startWindowEvery?: number): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/windowCount.ts:54
Branch out the source Observable values as a nested Observable with each nested Observable emitting at most windowSize values.

It's like bufferCount, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows every startWindowEvery items, each containing no more than windowSize items. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If startWindowEvery is not provided, then new windows are started immediately at the start of the source and when each window completes with size windowSize.

example

Ignore every 3rd click event, starting from the first one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(3) .map(win => win.skip(1)) // skip first of every 3 clicks .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

example

Ignore every 3rd click event, starting from the third one var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowCount(2, 3) .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

see

window

see

{@link windowTime}

see

windowToggle

see

windowWhen

see

bufferCount

method

windowCount

owner

Observable

Type parameters
- T
Parameters
- windowSize: number
 
 The maximum number of values emitted by each window.
- Default value startWindowEvery: number = 0
Returns Observable<Observable<T>>

An Observable of windows, which in turn are Observable of values.

"node_modules/rxjs/src/operator/windowTime"

"node_modules/rxjs/src/operator/windowTime":

WindowTimeOperator

WindowTimeOperator:

constructor

new WindowTimeOperator(windowTimeSpan: number, windowCreationInterval: number, scheduler: Scheduler): WindowTimeOperator

- Defined in node_modules/rxjs/src/operator/windowTime.ts:69
Parameters
- windowTimeSpan: number
- windowCreationInterval: number
- scheduler: Scheduler
Returns WindowTimeOperator

scheduler

scheduler: Scheduler

windowCreationInterval

windowCreationInterval: number

windowTimeSpan

windowTimeSpan: number

call

call(subscriber: Subscriber<Observable<T>>, source: any): any

- Defined in node_modules/rxjs/src/operator/windowTime.ts:76
Parameters
- subscriber: Subscriber<Observable<T>>
- source: any
Returns any

WindowTimeSubscriber

WindowTimeSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new WindowTimeSubscriber(destination: Subscriber<Observable<T>>, windowTimeSpan: number, windowCreationInterval: number, scheduler: Scheduler): WindowTimeSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/windowTime.ts:96
Parameters
- destination: Subscriber<Observable<T>>
- windowTimeSpan: number
- windowCreationInterval: number
- scheduler: Scheduler
Returns WindowTimeSubscriber

destination

destination: Subscriber<Observable<T>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

windowCreationInterval

windowCreationInterval: number

windowTimeSpan

windowTimeSpan: number

windows

windows: Subject<T>[]

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/windowTime.ts:135
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/windowTime.ts:127
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/windowTime.ts:116
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

closeWindow

closeWindow(window: Subject<T>): void

- Defined in node_modules/rxjs/src/operator/windowTime.ts:155
Parameters
- window: Subject<T>
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

openWindow

openWindow(): Subject<T>

- Defined in node_modules/rxjs/src/operator/windowTime.ts:146
Returns Subject<T>

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

Context

Context:

action

action: Action<CreationState<T>>

subscription

subscription: Subscription

CreationState

CreationState:

scheduler

scheduler: Scheduler

subscriber

subscriber: WindowTimeSubscriber<T>

windowCreationInterval

windowCreationInterval: number

windowTimeSpan

windowTimeSpan: number

DispatchArg

DispatchArg:

context

context: Context<T>

subscriber

subscriber: WindowTimeSubscriber<T>

window

window: Subject<T>

TimeSpanOnlyState

TimeSpanOnlyState:

subscriber

subscriber: WindowTimeSubscriber<T>

window

window: Subject<any>

windowTimeSpan

windowTimeSpan: number

WindowTimeSignature

__call(windowTimeSpan: number, windowCreationInterval?: number, scheduler?: Scheduler): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/windowTime.ts:65
Parameters
- windowTimeSpan: number
- Optional windowCreationInterval: number
- Optional scheduler: Scheduler
Returns Observable<Observable<T>>

dispatchWindowClose

dispatchWindowClose<T>(arg: DispatchArg<T>): void

- Defined in node_modules/rxjs/src/operator/windowTime.ts:199
Type parameters
- T
Parameters
- arg: DispatchArg<T>
Returns void

dispatchWindowCreation

dispatchWindowCreation<T>(state: CreationState<T>): void

- Defined in node_modules/rxjs/src/operator/windowTime.ts:188
Type parameters
- T
Parameters
- state: CreationState<T>
Returns void

dispatchWindowTimeSpanOnly

dispatchWindowTimeSpanOnly<T>(state: TimeSpanOnlyState<T>): void

- Defined in node_modules/rxjs/src/operator/windowTime.ts:168
Type parameters
- T
Parameters
- state: TimeSpanOnlyState<T>
Returns void

windowTime

windowTime<T>(windowTimeSpan: number, windowCreationInterval?: number, scheduler?: Scheduler): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/windowTime.ts:59
Branch out the source Observable values as a nested Observable periodically in time.

It's like bufferTime, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable starts a new window periodically, as determined by the windowCreationInterval argument. It emits each window after a fixed timespan, specified by the windowTimeSpan argument. When the source Observable completes or encounters an error, the output Observable emits the current window and propagates the notification from the source Observable. If windowCreationInterval is not provided, the output Observable starts a new window when the previous window of duration windowTimeSpan completes.

example

In every window of 1 second each, emit at most 2 click events var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

example

Every 5 seconds start a window 1 second long, and emit at most 2 click events per window var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks.windowTime(1000, 5000) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

see

window

see

windowCount

see

windowToggle

see

windowWhen

see

bufferTime

method

windowTime

owner

Observable

Type parameters
- T
Parameters
- windowTimeSpan: number
 
 The amount of time to fill each window.
- Default value windowCreationInterval: number = null
- Default value scheduler: Scheduler = async
Returns Observable<Observable<T>>

An observable of windows, which in turn are Observables.

"node_modules/rxjs/src/operator/windowToggle"

"node_modules/rxjs/src/operator/windowToggle":

WindowToggleOperator

WindowToggleOperator:

constructor

new WindowToggleOperator(openings: Observable<O>, closingSelector: function): WindowToggleOperator

- Defined in node_modules/rxjs/src/operator/windowToggle.ts:64
Parameters
- openings: Observable<O>
- closingSelector: function
 - - (openValue: O): Observable<any>
 - Parameters
 - openValue: O
 Returns Observable<any>
Returns WindowToggleOperator

closingSelector

closingSelector: function

Type declaration

- (openValue: O): Observable<any>
- Parameters
 - openValue: O
 Returns Observable<any>

openings

openings: Observable<O>

call

call(subscriber: Subscriber<Observable<T>>, source: any): any

- Defined in node_modules/rxjs/src/operator/windowToggle.ts:70
Parameters
- subscriber: Subscriber<Observable<T>>
- source: any
Returns any

WindowToggleSubscriber

WindowToggleSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new WindowToggleSubscriber(destination: Subscriber<Observable<T>>, openings: Observable<O>, closingSelector: function): WindowToggleSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/windowToggle.ts:89
Parameters
- destination: Subscriber<Observable<T>>
- openings: Observable<O>
- closingSelector: function
 - - (openValue: O): Observable<any>
 - Parameters
 - openValue: O
 Returns Observable<any>
Returns WindowToggleSubscriber

closingSelector

closingSelector: function

Type declaration

- (openValue: O): Observable<any>
- Parameters
 - openValue: O
 Returns Observable<any>

contexts

contexts: WindowContext<T>[]

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

openSubscription

openSubscription: Subscription

openings

openings: Observable<O>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/windowToggle.ts:127
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/windowToggle.ts:108
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/windowToggle.ts:98
Parameters
- value: T
Returns void

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/operator/windowToggle.ts:142
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

closeWindow

closeWindow(index: number): void

- Defined in node_modules/rxjs/src/operator/windowToggle.ts:199
Parameters
- index: number
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(inner: Subscription): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/windowToggle.ts:193
Parameters
- inner: Subscription
Returns void

notifyError

notifyError(err: any): void

Overwrites OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/operator/windowToggle.ts:189
Parameters
- err: any
Returns void

notifyNext

notifyNext(outerValue: any, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/windowToggle.ts:156
Parameters
- outerValue: any
- innerValue: any
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, any>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WindowContext

WindowContext:

subscription

subscription: Subscription

window

window: Subject<T>

WindowToggleSignature

__call<O>(openings: Observable<O>, closingSelector: function): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/windowToggle.ts:60
Type parameters
- O
Parameters
- openings: Observable<O>
- closingSelector: function
 - - (openValue: O): Observable<any>
 - Parameters
 - openValue: O
 Returns Observable<any>
Returns Observable<Observable<T>>

windowToggle

windowToggle<T, O>(openings: Observable<O>, closingSelector: function): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/windowToggle.ts:55
Branch out the source Observable values as a nested Observable starting from an emission from openings and ending when the output of closingSelector emits.

It's like bufferToggle, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits windows that contain those items emitted by the source Observable between the time when the openings Observable emits an item and when the Observable returned by closingSelector emits an item.

example

Every other second, emit the click events from the next 500ms var clicks = Rx.Observable.fromEvent(document, 'click'); var openings = Rx.Observable.interval(1000); var result = clicks.windowToggle(openings, i => i % 2 ? Rx.Observable.interval(500) : Rx.Observable.empty() ).mergeAll(); result.subscribe(x => console.log(x));

see

window

see

windowCount

see

{@link windowTime}

see

windowWhen

see

bufferToggle

method

windowToggle

owner

Observable

Type parameters
- T
- O
Parameters
- openings: Observable<O>
 
 An observable of notifications to start new windows.
- closingSelector: function
 
 A function that takes the value emitted by the openings observable and returns an Observable, which, when it emits (either next or complete), signals that the associated window should complete.
 - - (openValue: O): Observable<any>
 - Parameters
 - openValue: O
 Returns Observable<any>
Returns Observable<Observable<T>>

An observable of windows, which in turn are Observables.

"node_modules/rxjs/src/operator/windowWhen"

"node_modules/rxjs/src/operator/windowWhen":

WindowOperator

WindowOperator:

constructor

new WindowOperator(closingSelector: function): WindowOperator

- Defined in node_modules/rxjs/src/operator/windowWhen.ts:60
Parameters
- closingSelector: function
 - - (): Observable<any>
 - Returns Observable<any>
Returns WindowOperator

closingSelector

closingSelector: function

Type declaration

- (): Observable<any>
- Returns Observable<any>

call

call(subscriber: Subscriber<Observable<T>>, source: any): any

- Defined in node_modules/rxjs/src/operator/windowWhen.ts:64
Parameters
- subscriber: Subscriber<Observable<T>>
- source: any
Returns any

WindowSubscriber

WindowSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new WindowSubscriber(destination: Subscriber<Observable<T>>, closingSelector: function): WindowSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/windowWhen.ts:76
Parameters
- destination: Subscriber<Observable<T>>
- closingSelector: function
 - - (): Observable<any>
 - Returns Observable<any>
Returns WindowSubscriber

closingNotification

closingNotification: Subscription

closingSelector

closingSelector: function

Type declaration

- (): Observable<any>
- Returns Observable<any>

destination

destination: Subscriber<Observable<T>>

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

window

window: Subject<T>

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/windowWhen.ts:108
Returns void

_error

_error(err: any): void

Overwrites Subscriber._error
- Defined in node_modules/rxjs/src/operator/windowWhen.ts:102
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/windowWhen.ts:98
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(innerSub: InnerSubscriber<T, any>): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/windowWhen.ts:94
Parameters
- innerSub: InnerSubscriber<T, any>
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, any>): void

Overwrites OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/operator/windowWhen.ts:90
Parameters
- error: any
- innerSub: InnerSubscriber<T, any>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, any>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/windowWhen.ts:84
Parameters
- outerValue: T
- innerValue: any
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, any>
Returns void

openWindow

openWindow(innerSub?: InnerSubscriber<T, any>): void

- Defined in node_modules/rxjs/src/operator/windowWhen.ts:120
Parameters
- Default value innerSub: InnerSubscriber<T, any> = null
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

unsubscribeClosingNotification

unsubscribeClosingNotification(): void

- Defined in node_modules/rxjs/src/operator/windowWhen.ts:114
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WindowWhenSignature

__call(closingSelector: function): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/windowWhen.ts:56
Parameters
- closingSelector: function
 - - (): Observable<any>
 - Returns Observable<any>
Returns Observable<Observable<T>>

windowWhen

windowWhen<T>(closingSelector: function): Observable<Observable<T>>

- Defined in node_modules/rxjs/src/operator/windowWhen.ts:52
Branch out the source Observable values as a nested Observable using a factory function of closing Observables to determine when to start a new window.

It's like bufferWhen, but emits a nested Observable instead of an array.

Returns an Observable that emits windows of items it collects from the source Observable. The output Observable emits connected, non-overlapping windows. It emits the current window and opens a new one whenever the Observable produced by the specified closingSelector function emits an item. The first window is opened immediately when subscribing to the output Observable.

example

Emit only the first two clicks events in every window of [1-5] random seconds var clicks = Rx.Observable.fromEvent(document, 'click'); var result = clicks .windowWhen(() => Rx.Observable.interval(1000 + Math.random() * 4000)) .map(win => win.take(2)) // each window has at most 2 emissions .mergeAll(); // flatten the Observable-of-Observables result.subscribe(x => console.log(x));

see

window

see

windowCount

see

{@link windowTime}

see

windowToggle

see

bufferWhen

method

windowWhen

owner

Observable

Type parameters
- T
Parameters
- closingSelector: function
 
 A function that takes no arguments and returns an Observable that signals (on either next or complete) when to close the previous window and start a new one.
 - - (): Observable<any>
 - Returns Observable<any>
Returns Observable<Observable<T>>

An observable of windows, which in turn are Observables.

"node_modules/rxjs/src/operator/withLatestFrom"

"node_modules/rxjs/src/operator/withLatestFrom":

WithLatestFromOperator

WithLatestFromOperator:

constructor

new WithLatestFromOperator(observables: Observable<any>[], project?: function): WithLatestFromOperator

- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:76
Parameters
- observables: Observable<any>[]
- Optional project: function
 - - (...values: any[]): Observable<R>
 - Parameters
 - Rest ...values: any[]
 Returns Observable<R>
Returns WithLatestFromOperator

observables

observables: Observable<any>[]

project

project: function

Type declaration

- (...values: any[]): Observable<R>
- Parameters
 - Rest ...values: any[]
 Returns Observable<R>

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:81
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

WithLatestFromSubscriber

WithLatestFromSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new WithLatestFromSubscriber(destination: Subscriber<R>, observables: Observable<any>[], project?: function): WithLatestFromSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:93
Parameters
- destination: Subscriber<R>
- observables: Observable<any>[]
- Optional project: function
 - - (...values: any[]): Observable<R>
 - Parameters
 - Rest ...values: any[]
 Returns Observable<R>
Returns WithLatestFromSubscriber

destination

destination: PartialObserver

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

observables

observables: Observable<any>[]

project

project: function

Type declaration

- (...values: any[]): Observable<R>
- Parameters
 - Rest ...values: any[]
 Returns Observable<R>

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

toRespond

toRespond: number[]

values

values: any[]

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:129
Parameters
- value: T
Returns void

_tryProject

_tryProject(args: any[]): void

- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:140
Parameters
- args: any[]
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:125
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: R, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:112
Parameters
- outerValue: T
- innerValue: R
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

WithLatestFromSignature

__call<R>(project: function): Observable<R>
__call<T2, R>(v2: ObservableInput, project: function): Observable<R>
__call<T2, T3, R>(v2: ObservableInput, v3: ObservableInput, project: function): Observable<R>
__call<T2, T3, T4, R>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, project: function): Observable<R>
__call<T2, T3, T4, T5, R>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, project: function): Observable<R>
__call<T2, T3, T4, T5, T6, R>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, project: function): Observable<R>
__call<T2>(v2: ObservableInput): Observable<[T, T2]>
__call<T2, T3>(v2: ObservableInput, v3: ObservableInput): Observable<[T, T2, T3]>
__call<T2, T3, T4>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput): Observable<[T, T2, T3, T4]>
__call<T2, T3, T4, T5>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput): Observable<[T, T2, T3, T4, T5]>
__call<T2, T3, T4, T5, T6>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput): Observable<[T, T2, T3, T4, T5, T6]>
__call<R>(...observables: Array<ObservableInput | function>): Observable<R>
__call<R>(array: ObservableInput[]): Observable<R>
__call<R>(array: ObservableInput[], project: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:56
Type parameters
- R
Parameters
- project: function
 - - (v1: T): R
 - Parameters
 - v1: T
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:57
Type parameters
- T2
- R
Parameters
- v2: ObservableInput
- project: function
 - - (v1: T, v2: T2): R
 - Parameters
 - v1: T
 - v2: T2
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:58
Type parameters
- T2
- T3
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:59
Type parameters
- T2
- T3
- T4
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:60
Type parameters
- T2
- T3
- T4
- T5
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:61
Type parameters
- T2
- T3
- T4
- T5
- T6
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:62
Type parameters
- T2
Parameters
- v2: ObservableInput
Returns Observable<[T, T2]>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:64
Type parameters
- T2
- T3
Parameters
- v2: ObservableInput
- v3: ObservableInput
Returns Observable<[T, T2, T3]>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:65
Type parameters
- T2
- T3
- T4
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
Returns Observable<[T, T2, T3, T4]>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:66
Type parameters
- T2
- T3
- T4
- T5
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
Returns Observable<[T, T2, T3, T4, T5]>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:67
Type parameters
- T2
- T3
- T4
- T5
- T6
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
Returns Observable<[T, T2, T3, T4, T5, T6]>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:68
Type parameters
- R
Parameters
- Rest ...observables: Array<ObservableInput | function>
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:70
Type parameters
- R
Parameters
- array: ObservableInput[]
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:71
Type parameters
- R
Parameters
- array: ObservableInput[]
- project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
Returns Observable<R>

withLatestFrom

withLatestFrom<T, R>(...args: Array<ObservableInput | function>): Observable<R>

- Defined in node_modules/rxjs/src/operator/withLatestFrom.ts:46
Combines the source Observable with other Observables to create an Observable whose values are calculated from the latest values of each, only when the source emits.

Whenever the source Observable emits a value, it computes a formula using that value plus the latest values from other input Observables, then emits the output of that formula.

withLatestFrom combines each value from the source Observable (the instance) with the latest values from the other input Observables only when the source emits a value, optionally using a project function to determine the value to be emitted on the output Observable. All input Observables must emit at least one value before the output Observable will emit a value.

example

On every click event, emit an array with the latest timer event plus the click event var clicks = Rx.Observable.fromEvent(document, 'click'); var timer = Rx.Observable.interval(1000); var result = clicks.withLatestFrom(timer); result.subscribe(x => console.log(x));

see

combineLatest

method

withLatestFrom

owner

Observable

Type parameters
- T
- R
Parameters
- Rest ...args: Array<ObservableInput | function>
Returns Observable<R>

An Observable of projected values from the most recent values from each input Observable, or an array of the most recent values from each input Observable.

"node_modules/rxjs/src/operator/zip"

"node_modules/rxjs/src/operator/zip":

StaticArrayIterator

StaticArrayIterator:

constructor

new StaticArrayIterator(array: T[]): StaticArrayIterator

- Defined in node_modules/rxjs/src/operator/zip.ts:229
Parameters
- array: T[]
Returns StaticArrayIterator

array

array: T[]

index

index: number

length

length: number

__computed

__computed(): StaticArrayIterator<T>

- Defined in node_modules/rxjs/src/operator/zip.ts:235
Returns StaticArrayIterator<T>

hasCompleted

hasCompleted(): boolean

Implementation of LookAheadIterator.hasCompleted
- Defined in node_modules/rxjs/src/operator/zip.ts:249
Returns boolean

hasValue

hasValue(): boolean

Implementation of LookAheadIterator.hasValue
- Defined in node_modules/rxjs/src/operator/zip.ts:245
Returns boolean

next(value?: any): IteratorResult<T>

Implementation of LookAheadIterator.next
- Defined in node_modules/rxjs/src/operator/zip.ts:239
Parameters
- Optional value: any
Returns IteratorResult<T>

StaticIterator

StaticIterator:

constructor

new StaticIterator(iterator: Iterator<T>): StaticIterator

- Defined in node_modules/rxjs/src/operator/zip.ts:205
Parameters
- iterator: Iterator<T>
Returns StaticIterator

iterator

iterator: Iterator<T>

nextResult

nextResult: IteratorResult<T>

hasCompleted

hasCompleted(): boolean

Implementation of LookAheadIterator.hasCompleted
- Defined in node_modules/rxjs/src/operator/zip.ts:221
Returns boolean

hasValue

hasValue(): boolean

Implementation of LookAheadIterator.hasValue
- Defined in node_modules/rxjs/src/operator/zip.ts:211
Returns boolean

next(): IteratorResult<T>

- Defined in node_modules/rxjs/src/operator/zip.ts:215
Returns IteratorResult<T>

ZipBufferIterator

ZipBufferIterator:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ZipBufferIterator(destination: PartialObserver, parent: ZipSubscriber<T, R>, observable: Observable<T>, index: number): ZipBufferIterator

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/zip.ts:262
Parameters
- destination: PartialObserver
- parent: ZipSubscriber<T, R>
- observable: Observable<T>
- index: number
Returns ZipBufferIterator

buffer

buffer: T[]

destination

destination: PartialObserver

index

index: number

isComplete

isComplete: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

observable

observable: Observable<T>

parent

parent: ZipSubscriber<T, R>

stillUnsubscribed

stillUnsubscribed: boolean

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

EMPTY

EMPTY: Subscription

__computed

__computed(): ZipBufferIterator<T, R>

Overwrites Subscriber.__computed
- Defined in node_modules/rxjs/src/operator/zip.ts:271
Returns ZipBufferIterator<T, R>

_complete

_complete(): void

Inherited from Subscriber._complete
- Defined in node_modules/rxjs/src/Subscriber.ts:141
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: T): void

Inherited from Subscriber._next
- Defined in node_modules/rxjs/src/Subscriber.ts:132
Parameters
- value: T
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

hasCompleted

hasCompleted(): boolean

Implementation of LookAheadIterator.hasCompleted
- Defined in node_modules/rxjs/src/operator/zip.ts:290
Returns boolean

hasValue

hasValue(): boolean

Implementation of LookAheadIterator.hasValue
- Defined in node_modules/rxjs/src/operator/zip.ts:286
Returns boolean

next(): IteratorResult<T>

Overwrites Subscriber.next
- Defined in node_modules/rxjs/src/operator/zip.ts:277
Returns IteratorResult<T>

notifyComplete

notifyComplete(): void

Overwrites OuterSubscriber.notifyComplete
- Defined in node_modules/rxjs/src/operator/zip.ts:294
Returns void

notifyError

notifyError(error: any, innerSub: InnerSubscriber<T, R>): void

Inherited from OuterSubscriber.notifyError
- Defined in node_modules/rxjs/src/OuterSubscriber.ts:16
Parameters
- error: any
- innerSub: InnerSubscriber<T, R>
Returns void

notifyNext

notifyNext(outerValue: T, innerValue: any, outerIndex: number, innerIndex: number, innerSub: InnerSubscriber<T, R>): void

Overwrites OuterSubscriber.notifyNext
- Defined in node_modules/rxjs/src/operator/zip.ts:303
Parameters
- outerValue: T
- innerValue: any
- outerIndex: number
- innerIndex: number
- innerSub: InnerSubscriber<T, R>
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

subscribe(value: any, index: number): Subscription

- Defined in node_modules/rxjs/src/operator/zip.ts:310
Parameters
- value: any
- index: number
Returns Subscription

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

ZipOperator

ZipOperator:

constructor

new ZipOperator(project?: function): ZipOperator

- Defined in node_modules/rxjs/src/operator/zip.ts:79
Parameters
- Optional project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
Returns ZipOperator

project

project: function

Type declaration

- (...values: Array<any>): R
- Parameters
 - Rest ...values: Array<any>
 Returns R

call

call(subscriber: Subscriber<R>, source: any): any

- Defined in node_modules/rxjs/src/operator/zip.ts:85
Parameters
- subscriber: Subscriber<R>
- source: any
Returns any

ZipSubscriber

ZipSubscriber:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ZipSubscriber(destination: Subscriber<R>, project?: function, values?: any): ZipSubscriber

Overwrites Subscriber.constructor
- Defined in node_modules/rxjs/src/operator/zip.ts:100
Parameters
- destination: Subscriber<R>
- Optional project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
- Default value values: any = Object.create(null)
Returns ZipSubscriber

active

active: number

destination

destination: PartialObserver

index

index: number

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

iterators

iterators: LookAheadIterator<any>[]

project

project: function

Type declaration

- (...values: Array<any>): R
- Parameters
 - Rest ...values: Array<any>
 Returns R

syncErrorThrowable

syncErrorThrowable: boolean

syncErrorThrown

syncErrorThrown: boolean

syncErrorValue

syncErrorValue: any

values

values: any

EMPTY

EMPTY: Subscription

__computed

__computed(): Subscriber<T>

Inherited from Subscriber.__computed
- Defined in node_modules/rxjs/src/Subscriber.ts:146
Returns Subscriber<T>

_complete

_complete(): void

Overwrites Subscriber._complete
- Defined in node_modules/rxjs/src/operator/zip.ts:122
Returns void

_error

_error(err: any): void

Inherited from Subscriber._error
- Defined in node_modules/rxjs/src/Subscriber.ts:136
Parameters
- err: any
Returns void

_next

_next(value: any): void

Overwrites Subscriber._next
- Defined in node_modules/rxjs/src/operator/zip.ts:110
Parameters
- value: any
Returns void

_tryProject

_tryProject(args: any[]): void

- Defined in node_modules/rxjs/src/operator/zip.ts:187
Parameters
- args: any[]
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

checkIterators

checkIterators(): void

- Defined in node_modules/rxjs/src/operator/zip.ts:143
Returns void

complete

complete(): void

Inherited from Subscriber.complete
- Defined in node_modules/rxjs/src/Subscriber.ts:117
The Observer callback to receive a valueless notification of type complete from the Observable. Notifies the Observer that the Observable has finished sending push-based notifications.

Returns void

error

error(err?: any): void

Inherited from Subscriber.error
- Defined in node_modules/rxjs/src/Subscriber.ts:104
The Observer callback to receive notifications of type error from the Observable, with an attached Error. Notifies the Observer that the Observable has experienced an error condition.

Parameters
- Optional err: any
Returns void

next(value?: T): void

Inherited from Subscriber.next
- Defined in node_modules/rxjs/src/Subscriber.ts:91
The Observer callback to receive notifications of type next from the Observable, with a value. The Observable may call this method 0 or more times.

Parameters
- Optional value: T
Returns void

notifyInactive

notifyInactive(): void

- Defined in node_modules/rxjs/src/operator/zip.ts:136
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscriber.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscriber.ts:124
Returns void

create

create<T>(next?: function, error?: function, complete?: function): Subscriber<T>

Inherited from Subscriber.create
- Defined in node_modules/rxjs/src/Subscriber.ts:30
A static factory for a Subscriber, given a (potentially partial) definition of an Observer.

Type parameters
- T
Parameters
- Optional next: function
 - - (x?: T): void
 - Parameters
 - Optional x: T
 Returns void
- Optional error: function
 - - (e?: any): void
 - Parameters
 - Optional e: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

A Subscriber wrapping the (partially defined) Observer represented by the given arguments.

LookAheadIterator

LookAheadIterator:

hasCompleted

hasCompleted(): boolean

- Defined in node_modules/rxjs/src/operator/zip.ts:201
Returns boolean

hasValue

hasValue(): boolean

- Defined in node_modules/rxjs/src/operator/zip.ts:200
Returns boolean

next(value?: any): IteratorResult<T>

Inherited from Iterator.next

Overwrites Iterator.next
- Defined in typings/browser/ambient/es6-shim/index.d.ts:23
Parameters
- Optional value: any
Returns IteratorResult<T>

return

return(value?: any): IteratorResult<T>

Inherited from Iterator.return

Overwrites Iterator.return
- Defined in typings/browser/ambient/es6-shim/index.d.ts:24
Parameters
- Optional value: any
Returns IteratorResult<T>

throw

throw(e?: any): IteratorResult<T>

Inherited from Iterator.throw

Overwrites Iterator.throw
- Defined in typings/browser/ambient/es6-shim/index.d.ts:25
Parameters
- Optional e: any
Returns IteratorResult<T>

ZipSignature

__call<R>(project: function): Observable<R>
__call<T2, R>(v2: ObservableInput, project: function): Observable<R>
__call<T2, T3, R>(v2: ObservableInput, v3: ObservableInput, project: function): Observable<R>
__call<T2, T3, T4, R>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, project: function): Observable<R>
__call<T2, T3, T4, T5, R>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, project: function): Observable<R>
__call<T2, T3, T4, T5, T6, R>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, project: function): Observable<R>
__call<T2>(v2: ObservableInput): Observable<[T, T2]>
__call<T2, T3>(v2: ObservableInput, v3: ObservableInput): Observable<[T, T2, T3]>
__call<T2, T3, T4>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput): Observable<[T, T2, T3, T4]>
__call<T2, T3, T4, T5>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput): Observable<[T, T2, T3, T4, T5]>
__call<T2, T3, T4, T5, T6>(v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput): Observable<[T, T2, T3, T4, T5, T6]>
__call<R>(...observables: Array<ObservableInput | function>): Observable<R>
__call<R>(array: ObservableInput[]): Observable<R>
__call<R>(array: ObservableInput[], project: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/zip.ts:24
Type parameters
- R
Parameters
- project: function
 - - (v1: T): R
 - Parameters
 - v1: T
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:25
Type parameters
- T2
- R
Parameters
- v2: ObservableInput
- project: function
 - - (v1: T, v2: T2): R
 - Parameters
 - v1: T
 - v2: T2
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:26
Type parameters
- T2
- T3
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:27
Type parameters
- T2
- T3
- T4
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:28
Type parameters
- T2
- T3
- T4
- T5
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:29
Type parameters
- T2
- T3
- T4
- T5
- T6
- R
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:30
Type parameters
- T2
Parameters
- v2: ObservableInput
Returns Observable<[T, T2]>
- Defined in node_modules/rxjs/src/operator/zip.ts:32
Type parameters
- T2
- T3
Parameters
- v2: ObservableInput
- v3: ObservableInput
Returns Observable<[T, T2, T3]>
- Defined in node_modules/rxjs/src/operator/zip.ts:33
Type parameters
- T2
- T3
- T4
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
Returns Observable<[T, T2, T3, T4]>
- Defined in node_modules/rxjs/src/operator/zip.ts:34
Type parameters
- T2
- T3
- T4
- T5
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
Returns Observable<[T, T2, T3, T4, T5]>
- Defined in node_modules/rxjs/src/operator/zip.ts:35
Type parameters
- T2
- T3
- T4
- T5
- T6
Parameters
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
Returns Observable<[T, T2, T3, T4, T5, T6]>
- Defined in node_modules/rxjs/src/operator/zip.ts:36
Type parameters
- R
Parameters
- Rest ...observables: Array<ObservableInput | function>
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:38
Type parameters
- R
Parameters
- array: ObservableInput[]
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:39
Type parameters
- R
Parameters
- array: ObservableInput[]
- project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
Returns Observable<R>

zipProto

zipProto<R>(...observables: Array<ObservableInput | function>): Observable<R>

- Defined in node_modules/rxjs/src/operator/zip.ts:18
method

zip

owner

Observable

Type parameters
- R
Parameters
- Rest ...observables: Array<ObservableInput | function>
Returns Observable<R>

zipStatic

zipStatic<T>(v1: ObservableInput): Observable<[T]>
zipStatic<T, T2>(v1: ObservableInput, v2: ObservableInput): Observable<[T, T2]>
zipStatic<T, T2, T3>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput): Observable<[T, T2, T3]>
zipStatic<T, T2, T3, T4>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput): Observable<[T, T2, T3, T4]>
zipStatic<T, T2, T3, T4, T5>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput): Observable<[T, T2, T3, T4, T5]>
zipStatic<T, T2, T3, T4, T5, T6>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput): Observable<[T, T2, T3, T4, T5, T6]>
zipStatic<T, R>(v1: ObservableInput, project: function): Observable<R>
zipStatic<T, T2, R>(v1: ObservableInput, v2: ObservableInput, project: function): Observable<R>
zipStatic<T, T2, T3, R>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, project: function): Observable<R>
zipStatic<T, T2, T3, T4, R>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, project: function): Observable<R>
zipStatic<T, T2, T3, T4, T5, R>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, project: function): Observable<R>
zipStatic<T, T2, T3, T4, T5, T6, R>(v1: ObservableInput, v2: ObservableInput, v3: ObservableInput, v4: ObservableInput, v5: ObservableInput, v6: ObservableInput, project: function): Observable<R>
zipStatic<R>(...observables: Array<ObservableInput | function>): Observable<R>
zipStatic<R>(array: ObservableInput[]): Observable<R>
zipStatic<R>(array: ObservableInput[], project: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/zip.ts:45
Type parameters
- T
Parameters
- v1: ObservableInput
Returns Observable<[T]>
- Defined in node_modules/rxjs/src/operator/zip.ts:46
Type parameters
- T
- T2
Parameters
- v1: ObservableInput
- v2: ObservableInput
Returns Observable<[T, T2]>
- Defined in node_modules/rxjs/src/operator/zip.ts:47
Type parameters
- T
- T2
- T3
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
Returns Observable<[T, T2, T3]>
- Defined in node_modules/rxjs/src/operator/zip.ts:48
Type parameters
- T
- T2
- T3
- T4
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
Returns Observable<[T, T2, T3, T4]>
- Defined in node_modules/rxjs/src/operator/zip.ts:49
Type parameters
- T
- T2
- T3
- T4
- T5
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
Returns Observable<[T, T2, T3, T4, T5]>
- Defined in node_modules/rxjs/src/operator/zip.ts:50
Type parameters
- T
- T2
- T3
- T4
- T5
- T6
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
Returns Observable<[T, T2, T3, T4, T5, T6]>
- Defined in node_modules/rxjs/src/operator/zip.ts:51
Type parameters
- T
- R
Parameters
- v1: ObservableInput
- project: function
 - - (v1: T): R
 - Parameters
 - v1: T
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:52
Type parameters
- T
- T2
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- project: function
 - - (v1: T, v2: T2): R
 - Parameters
 - v1: T
 - v2: T2
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:53
Type parameters
- T
- T2
- T3
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:54
Type parameters
- T
- T2
- T3
- T4
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:55
Type parameters
- T
- T2
- T3
- T4
- T5
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:56
Type parameters
- T
- T2
- T3
- T4
- T5
- T6
- R
Parameters
- v1: ObservableInput
- v2: ObservableInput
- v3: ObservableInput
- v4: ObservableInput
- v5: ObservableInput
- v6: ObservableInput
- project: function
 - - (v1: T, v2: T2, v3: T3, v4: T4, v5: T5, v6: T6): R
 - Parameters
 - v1: T
 - v2: T2
 - v3: T3
 - v4: T4
 - v5: T5
 - v6: T6
 Returns R
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:57
Type parameters
- R
Parameters
- Rest ...observables: Array<ObservableInput | function>
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:58
Type parameters
- R
Parameters
- array: ObservableInput[]
Returns Observable<R>
- Defined in node_modules/rxjs/src/operator/zip.ts:59
Type parameters
- R
Parameters
- array: ObservableInput[]
- project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
Returns Observable<R>

"node_modules/rxjs/src/operator/zipAll"

"node_modules/rxjs/src/operator/zipAll":

ZipAllSignature

__call(): Observable<T[]>
__call<R>(project?: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/zipAll.ts:14
Returns Observable<T[]>
- Defined in node_modules/rxjs/src/operator/zipAll.ts:15
Type parameters
- R
Parameters
- Optional project: function
 - - (...values: Array<T>): R
 - Parameters
 - Rest ...values: Array<T>
 Returns R
Returns Observable<R>

zipAll

zipAll<T, R>(project?: function): Observable<R>

- Defined in node_modules/rxjs/src/operator/zipAll.ts:10
method

zipAll

owner

Observable

Type parameters
- T
- R
Parameters
- Optional project: function
 - - (...values: Array<any>): R
 - Parameters
 - Rest ...values: Array<any>
 Returns R
Returns Observable<R>

"node_modules/rxjs/src/scheduler/Action"

"node_modules/rxjs/src/scheduler/Action":

Action

Action:

constructor

new Action(unsubscribe?: function): Action

Inherited from Subscription.constructor
- Defined in node_modules/rxjs/src/Subscription.ts:43
Parameters
- Optional unsubscribe: function
  - - (): void
    - Returns void
Returns Action

delay

delay: number

error

error: any

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

- (state?: T): void | Subscription
- Parameters
  - Optional state: T
  Returns void | Subscription

EMPTY

EMPTY: Subscription

add

add(teardown: TeardownLogic): Subscription

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

execute(): void

- Defined in node_modules/rxjs/src/scheduler/Action.ts:9
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

schedule

schedule(state?: T, delay?: number): void

- Defined in node_modules/rxjs/src/scheduler/Action.ts:8
Parameters
- Optional state: T
- Optional delay: number
Returns void

unsubscribe

unsubscribe(): void

Inherited from Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscription.ts:61
Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

Returns void

"node_modules/rxjs/src/scheduler/AnimationFrameAction"

"node_modules/rxjs/src/scheduler/AnimationFrameAction":

AnimationFrameAction

AnimationFrameAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new AnimationFrameAction(scheduler: Scheduler, work: function): AnimationFrameAction

Inherited from FutureAction.constructor

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:18
Parameters
- scheduler: Scheduler
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
Returns AnimationFrameAction

delay

delay: number

error

error: any

id

id: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

- (x?: T): Subscription | void
- Parameters
  - Optional x: T
  Returns Subscription | void

EMPTY

EMPTY: Subscription

_schedule

_schedule(state?: T, delay?: number): Action<T>

Overwrites FutureAction._schedule
- Defined in node_modules/rxjs/src/scheduler/AnimationFrameAction.ts:12
Parameters
- Optional state: T
- Default value delay: number = 0
Returns Action<T>

_unsubscribe

_unsubscribe(): void

Overwrites FutureAction._unsubscribe
- Defined in node_modules/rxjs/src/scheduler/AnimationFrameAction.ts:29
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of Action.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

execute(): void

Implementation of Action.execute

Inherited from FutureAction.execute
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:25
Returns void

remove

remove(subscription: Subscription): void

Implementation of Action.remove

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

schedule

schedule(state?: T, delay?: number): Action<T>

Implementation of Action.schedule

Inherited from FutureAction.schedule
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:38
Parameters
- Optional state: T
- Default value delay: number = 0
Returns Action<T>

unsubscribe

unsubscribe(): void

Implementation of Action.unsubscribe

Inherited from Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscription.ts:61
Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

Returns void

"node_modules/rxjs/src/scheduler/AnimationFrameScheduler"

"node_modules/rxjs/src/scheduler/AnimationFrameScheduler":

AnimationFrameScheduler

AnimationFrameScheduler:

actions

actions: QueueAction<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

flush(): void

Implementation of Scheduler.flush

Inherited from QueueScheduler.flush
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:16
Returns void

now

now(): number

Implementation of Scheduler.now

Inherited from QueueScheduler.now
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:12
Returns number

schedule

schedule<T>(work: function, delay?: number, state?: T): Subscription

Inherited from QueueScheduler.schedule
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:33
Type parameters
- T
Parameters
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
- Default value delay: number = 0
- Optional state: T
Returns Subscription

scheduleLater

scheduleLater<T>(work: function, delay: number, state?: T): Action<T>

Inherited from QueueScheduler.scheduleLater
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:43
Type parameters
- T
Parameters
- work: function
 - - (x?: T): Subscription | void
 - Parameters
 - Optional x: T
 Returns Subscription | void
- delay: number
- Optional state: T
Returns Action<T>

scheduleNow

scheduleNow<T>(work: function, state?: T): Action<T>

Overwrites QueueScheduler.scheduleNow
- Defined in node_modules/rxjs/src/scheduler/AnimationFrameScheduler.ts:7
Type parameters
- T
Parameters
- work: function
 - - (x?: T): Subscription
 - Parameters
 - Optional x: T
 Returns Subscription
- Optional state: T
Returns Action<T>

"node_modules/rxjs/src/scheduler/AsapAction"

"node_modules/rxjs/src/scheduler/AsapAction":

AsapAction

AsapAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new AsapAction(scheduler: Scheduler, work: function): AsapAction

Inherited from FutureAction.constructor

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:18
Parameters
- scheduler: Scheduler
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
Returns AsapAction

delay

delay: number

error

error: any

id

id: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

- (x?: T): Subscription | void
- Parameters
  - Optional x: T
  Returns Subscription | void

EMPTY

EMPTY: Subscription

_schedule

_schedule(state?: T, delay?: number): Action<T>

Overwrites FutureAction._schedule
- Defined in node_modules/rxjs/src/scheduler/AsapAction.ts:12
Parameters
- Optional state: T
- Default value delay: number = 0
Returns Action<T>

_unsubscribe

_unsubscribe(): void

Overwrites FutureAction._unsubscribe
- Defined in node_modules/rxjs/src/scheduler/AsapAction.ts:29
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of Action.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

execute(): void

Implementation of Action.execute

Inherited from FutureAction.execute
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:25
Returns void

remove

remove(subscription: Subscription): void

Implementation of Action.remove

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

schedule

schedule(state?: T, delay?: number): Action<T>

Implementation of Action.schedule

Inherited from FutureAction.schedule
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:38
Parameters
- Optional state: T
- Default value delay: number = 0
Returns Action<T>

unsubscribe

unsubscribe(): void

Implementation of Action.unsubscribe

Inherited from Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscription.ts:61
Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

Returns void

"node_modules/rxjs/src/scheduler/AsapScheduler"

"node_modules/rxjs/src/scheduler/AsapScheduler":

AsapScheduler

AsapScheduler:

actions

actions: QueueAction<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

flush(): void

Implementation of Scheduler.flush

Inherited from QueueScheduler.flush
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:16
Returns void

now

now(): number

Implementation of Scheduler.now

Inherited from QueueScheduler.now
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:12
Returns number

schedule

schedule<T>(work: function, delay?: number, state?: T): Subscription

Inherited from QueueScheduler.schedule
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:33
Type parameters
- T
Parameters
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
- Default value delay: number = 0
- Optional state: T
Returns Subscription

scheduleLater

scheduleLater<T>(work: function, delay: number, state?: T): Action<T>

Inherited from QueueScheduler.scheduleLater
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:43
Type parameters
- T
Parameters
- work: function
 - - (x?: T): Subscription | void
 - Parameters
 - Optional x: T
 Returns Subscription | void
- delay: number
- Optional state: T
Returns Action<T>

scheduleNow

scheduleNow<T>(work: function, state?: T): Action<T>

Overwrites QueueScheduler.scheduleNow
- Defined in node_modules/rxjs/src/scheduler/AsapScheduler.ts:7
Type parameters
- T
Parameters
- work: function
 - - (x?: T): Subscription
 - Parameters
 - Optional x: T
 Returns Subscription
- Optional state: T
Returns Action<T>

"node_modules/rxjs/src/scheduler/AsyncScheduler"

"node_modules/rxjs/src/scheduler/AsyncScheduler":

AsyncScheduler

AsyncScheduler:

actions

actions: QueueAction<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

flush(): void

Implementation of Scheduler.flush

Inherited from QueueScheduler.flush
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:16
Returns void

now

now(): number

Implementation of Scheduler.now

Inherited from QueueScheduler.now
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:12
Returns number

schedule

schedule<T>(work: function, delay?: number, state?: T): Subscription

Inherited from QueueScheduler.schedule
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:33
Type parameters
- T
Parameters
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
- Default value delay: number = 0
- Optional state: T
Returns Subscription

scheduleLater

scheduleLater<T>(work: function, delay: number, state?: T): Action<T>

Inherited from QueueScheduler.scheduleLater
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:43
Type parameters
- T
Parameters
- work: function
 - - (x?: T): Subscription | void
 - Parameters
 - Optional x: T
 Returns Subscription | void
- delay: number
- Optional state: T
Returns Action<T>

scheduleNow

scheduleNow<T>(work: function, state?: T): Action<T>

Overwrites QueueScheduler.scheduleNow
- Defined in node_modules/rxjs/src/scheduler/AsyncScheduler.ts:7
Type parameters
- T
Parameters
- work: function
 - - (x?: T): Subscription
 - Parameters
 - Optional x: T
 Returns Subscription
- Optional state: T
Returns Action<T>

"node_modules/rxjs/src/scheduler/FutureAction"

"node_modules/rxjs/src/scheduler/FutureAction":

FutureAction

FutureAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new FutureAction(scheduler: Scheduler, work: function): FutureAction

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:18
Parameters
- scheduler: Scheduler
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
Returns FutureAction

delay

delay: number

error

error: any

id

id: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

pending

pending: boolean

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

- (x?: T): Subscription | void
- Parameters
  - Optional x: T
  Returns Subscription | void

EMPTY

EMPTY: Subscription

_schedule

_schedule(state?: T, delay?: number): Action<T>

- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:45
Parameters
- Optional state: T
- Default value delay: number = 0
Returns Action<T>

_unsubscribe

_unsubscribe(): void

- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:127
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of Action.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

execute(): void

Implementation of Action.execute
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:25
Returns void

remove

remove(subscription: Subscription): void

Implementation of Action.remove

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

schedule

schedule(state?: T, delay?: number): Action<T>

Implementation of Action.schedule
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:38
Parameters
- Optional state: T
- Default value delay: number = 0
Returns Action<T>

unsubscribe

unsubscribe(): void

Implementation of Action.unsubscribe

Inherited from Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscription.ts:61
Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

Returns void

"node_modules/rxjs/src/scheduler/MiscJSDoc"

"node_modules/rxjs/src/scheduler/MiscJSDoc":

ActionDoc

ActionDoc:

A unit of work to be executed in a Scheduler. An action is typically created from within a Scheduler and an RxJS user does not need to concern themselves about creating and manipulating an Action.

interface Action extends Subscription {
  work: (state?: any) => void|Subscription;
  state?: any;
  delay?: number;
  schedule(state?: any, delay?: number): void;
  execute(): void;
  scheduler: Scheduler;
  error: any;
}

interface
name: Action
noimport: true

constructor

new ActionDoc(unsubscribe?: function): ActionDoc

Inherited from Subscription.constructor
- Defined in node_modules/rxjs/src/Subscription.ts:43
Parameters
- Optional unsubscribe: function
  - - (): void
    - Returns void
Returns ActionDoc

delay

delay: number

Represents the time (relative to the Scheduler's own clock) when this action should be executed.

type: {number}

error

error: any

A reference to the latest error that may have occurred during action execution.

type: {any}

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

The Scheduler which owns this action.

type: {Scheduler}

state

state: any

The current state. This is the object that will be given to the work method.

type: {any}

EMPTY

EMPTY: Subscription

add

add(teardown: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

execute(): void

- Defined in node_modules/rxjs/src/scheduler/MiscJSDoc.ts:69
Immediately executes this action and the work it contains.

Returns void

remove

remove(subscription: Subscription): void

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

schedule

schedule(state?: any, delay?: number): void

- Defined in node_modules/rxjs/src/scheduler/MiscJSDoc.ts:61
Schedules this action on its parent Scheduler for execution. May be passed some context object, state. May happen at some point in the future, according to the delay parameter, if specified.

Parameters
- Optional state: any
- Optional delay: number
Returns void

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscription.ts:61
Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

Returns void

work

work(state?: any): void | Subscription

- Defined in node_modules/rxjs/src/scheduler/MiscJSDoc.ts:33
The function that represents the raw work to be executed on a Scheduler.

Parameters
- Optional state: any
Returns void | Subscription

A subscription in order to be able to unsubscribe the scheduled work.

"node_modules/rxjs/src/scheduler/QueueAction"

"node_modules/rxjs/src/scheduler/QueueAction":

QueueAction

QueueAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new QueueAction(scheduler: Scheduler, work: function): QueueAction

Inherited from FutureAction.constructor

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:18
Parameters
- scheduler: Scheduler
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
Returns QueueAction

delay

delay: number

error

error: any

id

id: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: Scheduler

state

state: T

work

work: function

Type declaration

- (x?: T): Subscription | void
- Parameters
  - Optional x: T
  Returns Subscription | void

EMPTY

EMPTY: Subscription

_schedule

_schedule(state?: T, delay?: number): Action<T>

Overwrites FutureAction._schedule
- Defined in node_modules/rxjs/src/scheduler/QueueAction.ts:10
Parameters
- Optional state: T
- Default value delay: number = 0
Returns Action<T>

_unsubscribe

_unsubscribe(): void

Inherited from FutureAction._unsubscribe
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:127
Returns void

add

add(teardown: TeardownLogic): Subscription

Implementation of Action.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

execute(): void

Implementation of Action.execute

Inherited from FutureAction.execute
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:25
Returns void

remove

remove(subscription: Subscription): void

Implementation of Action.remove

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

schedule

schedule(state?: T, delay?: number): Action<T>

Implementation of Action.schedule

Inherited from FutureAction.schedule
- Defined in node_modules/rxjs/src/scheduler/FutureAction.ts:38
Parameters
- Optional state: T
- Default value delay: number = 0
Returns Action<T>

unsubscribe

unsubscribe(): void

Implementation of Action.unsubscribe

Inherited from Subscription.unsubscribe
- Defined in node_modules/rxjs/src/Subscription.ts:61
Disposes the resources held by the subscription. May, for instance, cancel an ongoing Observable execution or cancel any other type of work that started when the Subscription was created.

Returns void

"node_modules/rxjs/src/scheduler/QueueScheduler"

"node_modules/rxjs/src/scheduler/QueueScheduler":

QueueScheduler

QueueScheduler:

actions

actions: QueueAction<any>[]

active

active: boolean

scheduledId

scheduledId: number

flush

flush(): void

Implementation of Scheduler.flush
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:16
Returns void

now

now(): number

Implementation of Scheduler.now
- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:12
Returns number

schedule

schedule<T>(work: function, delay?: number, state?: T): Subscription

- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:33
Type parameters
- T
Parameters
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
- Default value delay: number = 0
- Optional state: T
Returns Subscription

scheduleLater

scheduleLater<T>(work: function, delay: number, state?: T): Action<T>

- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:43
Type parameters
- T
Parameters
- work: function
 - - (x?: T): Subscription | void
 - Parameters
 - Optional x: T
 Returns Subscription | void
- delay: number
- Optional state: T
Returns Action<T>

scheduleNow

scheduleNow<T>(work: function, state?: T): Action<T>

- Defined in node_modules/rxjs/src/scheduler/QueueScheduler.ts:39
Type parameters
- T
Parameters
- work: function
 - - (x?: T): Subscription | void
 - Parameters
 - Optional x: T
 Returns Subscription | void
- Optional state: T
Returns Action<T>

"node_modules/rxjs/src/scheduler/VirtualTimeScheduler"

"node_modules/rxjs/src/scheduler/VirtualTimeScheduler":

VirtualAction

VirtualAction:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new VirtualAction(scheduler: VirtualTimeScheduler, work: function, index: number): VirtualAction

Overwrites Subscription.constructor
- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:78
Parameters
- scheduler: VirtualTimeScheduler
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
- index: number
Returns VirtualAction

calls

calls: number

delay

delay: number

error

error: any

index

index: number

isUnsubscribed

isUnsubscribed: boolean

A flag to indicate whether this Subscription has already been unsubscribed.

type: {boolean}

scheduler

scheduler: VirtualTimeScheduler

state

state: T

work

work: function

Type declaration

- (x?: T): Subscription | void
- Parameters
  - Optional x: T
  Returns Subscription | void

EMPTY

EMPTY: Subscription

add

add(teardown: TeardownLogic): Subscription

Implementation of Action.add

Inherited from Subscription.add
- Defined in node_modules/rxjs/src/Subscription.ts:129
Adds a tear down to be called during the unsubscribe() of this Subscription.

If the tear down being added is a subscription that is already unsubscribed, is the same reference add is being called on, or is Subscription.EMPTY, it will not be added.

If this subscription is already in an isUnsubscribed state, the passed tear down logic will be executed immediately.

Parameters
- teardown: TeardownLogic
  
  The additional logic to execute on teardown.
Returns Subscription

Returns the Subscription used or created to be added to the inner subscriptions list. This Subscription can be used with remove() to remove the passed teardown logic from the inner subscriptions list.

execute

execute(): void

Implementation of Action.execute
- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:107
Returns void

remove

remove(subscription: Subscription): void

Implementation of Action.remove

Inherited from Subscription.remove
- Defined in node_modules/rxjs/src/Subscription.ts:163
Removes a Subscription from the internal list of subscriptions that will unsubscribe during the unsubscribe process of this Subscription.

Parameters
- subscription: Subscription
  
  The subscription to remove.
Returns void

schedule

schedule(state?: T, delay?: number): VirtualAction<T>

Implementation of Action.schedule
- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:86
Parameters
- Optional state: T
- Default value delay: number = 0
Returns VirtualAction<T>

unsubscribe

unsubscribe(): void

Implementation of Action.unsubscribe

Overwrites Subscription.unsubscribe
- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:114
Returns void

VirtualTimeScheduler

VirtualTimeScheduler:

actions

actions: Action<any>[]

active

active: boolean

frame

frame: number

index

index: number

maxFrames

maxFrames: number

scheduledId

scheduledId: number

sorted

sorted: boolean

frameTimeFactor

frameTimeFactor: number

addAction

addAction<T>(action: Action<T>): void

- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:41
Type parameters
- T
Parameters
- action: Action<T>
Returns void

flush

flush(): void

Implementation of Scheduler.flush
- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:20
Returns void

now

now(): number

Implementation of Scheduler.now
- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:16
Returns number

schedule

schedule<T>(work: function, delay?: number, state?: T): Subscription

- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:63
Type parameters
- T
Parameters
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
- Default value delay: number = 0
- Optional state: T
Returns Subscription

"node_modules/rxjs/src/scheduler/animationFrame"

"node_modules/rxjs/src/scheduler/animationFrame":

animationFrame

animationFrame: AnimationFrameScheduler

"node_modules/rxjs/src/scheduler/asap"

"node_modules/rxjs/src/scheduler/asap":

asap

asap: AsapScheduler

"node_modules/rxjs/src/scheduler/async"

"node_modules/rxjs/src/scheduler/async":

async

async: AsyncScheduler

"node_modules/rxjs/src/scheduler/queue"

"node_modules/rxjs/src/scheduler/queue":

queue

queue: QueueScheduler

"node_modules/rxjs/src/symbol/iterator"

"node_modules/rxjs/src/symbol/iterator":

$$iterator

$$iterator: any

Symbol

Symbol: any

"node_modules/rxjs/src/symbol/observable"

"node_modules/rxjs/src/symbol/observable":

$$observable

$$observable: symbol

Symbol

Symbol: any

"node_modules/rxjs/src/symbol/rxSubscriber"

"node_modules/rxjs/src/symbol/rxSubscriber":

$$rxSubscriber

$$rxSubscriber: any

Symbol

Symbol: any

"node_modules/rxjs/src/testing/ColdObservable"

"node_modules/rxjs/src/testing/ColdObservable":

ColdObservable

ColdObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new ColdObservable(messages: TestMessage[], scheduler: Scheduler): ColdObservable

Overwrites Observable.constructor
- Defined in node_modules/rxjs/src/testing/ColdObservable.ts:19
Parameters
- messages: TestMessage[]
- scheduler: Scheduler
Returns ColdObservable

_isScalar

_isScalar: boolean

logSubscribedFrame

logSubscribedFrame: function

Type declaration

- (): number
- Returns number

logUnsubscribedFrame

logUnsubscribedFrame: function

Type declaration

- (index: number): void
- Parameters
  - index: number
  Returns void

messages

messages: TestMessage[]

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<any>

subscriptions

subscriptions: SubscriptionLog[]

if

if: create

throw

throw: create

__computed

__computed(): Observable<T>

Inherited from Observable.__computed
- Defined in node_modules/rxjs/src/Observable.ts:164
An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable

method

Symbol.observable

Returns Observable<T>

this instance of the observable

_subscribe

_subscribe(subscriber: Subscriber<any>): TeardownLogic

Inherited from Observable._subscribe
- Defined in node_modules/rxjs/src/Observable.ts:151
Parameters
- subscriber: Subscriber<any>
Returns TeardownLogic

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<R>(operator: Operator<T, R>): Observable<R>

Inherited from Observable.lift
- Defined in node_modules/rxjs/src/Observable.ts:68
Creates a new Observable, with this Observable as the source, and the passed operator defined as the new observable's operator.

method

lift

Type parameters
- R
Parameters
- operator: Operator<T, R>
 
 the operator defining the operation to take on the observable
Returns Observable<R>

a new observable with the Operator applied

scheduleMessages

scheduleMessages(subscriber: Subscriber<any>): void

- Defined in node_modules/rxjs/src/testing/ColdObservable.ts:35
Parameters
- subscriber: Subscriber<any>
Returns void

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

create

create<T>(subscribe?: function): Observable<T>

Inherited from Observable.create
- Defined in node_modules/rxjs/src/Observable.ts:57
Creates a new cold Observable by calling the Observable constructor

Type parameters
- T
Parameters
- Optional subscribe: function
 - - <R>(subscriber: Subscriber<R>): TeardownLogic
 - Type parameters
 - R
 Parameters
 - subscriber: Subscriber<R>
 Returns TeardownLogic
Returns Observable<T>

a new cold observable

"node_modules/rxjs/src/testing/HotObservable"

"node_modules/rxjs/src/testing/HotObservable":

HotObservable

HotObservable:

We need this JSDoc comment for affecting ESDoc.

ignore
extends: {Ignored}

constructor

new HotObservable(messages: TestMessage[], scheduler: Scheduler): HotObservable

Overwrites Subject.constructor
- Defined in node_modules/rxjs/src/testing/HotObservable.ts:19
Parameters
- messages: TestMessage[]
- scheduler: Scheduler
Returns HotObservable

_isScalar

_isScalar: boolean

destination

destination: Observer<T>

dispatching

dispatching: boolean

errorValue

errorValue: any

hasCompleted

hasCompleted: boolean

hasErrored

hasErrored: boolean

isStopped

isStopped: boolean

isUnsubscribed

isUnsubscribed: boolean

logSubscribedFrame

logSubscribedFrame: function

Type declaration

- (): number
- Returns number

logUnsubscribedFrame

logUnsubscribedFrame: function

Type declaration

- (index: number): void
- Parameters
  - index: number
  Returns void

messages

messages: TestMessage[]

observers

observers: Observer<T>[]

operator

operator: Operator<any, T>

scheduler

scheduler: Scheduler

source

source: Observable<T>

subscriptions

subscriptions: SubscriptionLog[]

if

if: create

throw

throw: create

__computed

__computed(): Subscriber<T>

Inherited from Subject.__computed

Overwrites Observable.__computed
- Defined in node_modules/rxjs/src/Subject.ts:222
Returns Subscriber<T>

_complete

_complete(): void

Inherited from Subject._complete
- Defined in node_modules/rxjs/src/Subject.ts:187
Returns void

_error

_error(err: any): void

Inherited from Subject._error
- Defined in node_modules/rxjs/src/Subject.ts:158
Parameters
- err: any
Returns void

_finalComplete

_finalComplete(): void

Inherited from Subject._finalComplete
- Defined in node_modules/rxjs/src/Subject.ts:195
Returns void

_finalError

_finalError(err: any): void

Inherited from Subject._finalError
- Defined in node_modules/rxjs/src/Subject.ts:166
Parameters
- err: any
Returns void

_finalNext

_finalNext(value: T): void

Inherited from Subject._finalNext
- Defined in node_modules/rxjs/src/Subject.ts:148
Parameters
- value: T
Returns void

_next

_next(value: T): void

Inherited from Subject._next
- Defined in node_modules/rxjs/src/Subject.ts:140
Parameters
- value: T
Returns void

_subscribe

_subscribe(subscriber: Subscriber<any>): TeardownLogic

Overwrites Subject._subscribe
- Defined in node_modules/rxjs/src/testing/HotObservable.ts:27
Parameters
- subscriber: Subscriber<any>
Returns TeardownLogic

_unsubscribe

_unsubscribe(): void

Inherited from Subject._unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:75
Returns void

add

add(subscription: TeardownLogic): Subscription

Implementation of ISubscription.add

Inherited from Subject.add
- Defined in node_modules/rxjs/src/Subject.ts:41
Parameters
- subscription: TeardownLogic
Returns Subscription

asObservable

asObservable(): Observable<T>

Inherited from Subject.asObservable
- Defined in node_modules/rxjs/src/Subject.ts:135
Returns Observable<T>

complete

complete(): void

Inherited from Subject.complete
- Defined in node_modules/rxjs/src/Subject.ts:118
Returns void

error

error(err?: any): void

Inherited from Subject.error
- Defined in node_modules/rxjs/src/Subject.ts:100
Parameters
- Optional err: any
Returns void

forEach

forEach(next: function, PromiseCtor?: PromiseConstructor): Promise<void>

Inherited from Observable.forEach
- Defined in node_modules/rxjs/src/Observable.ts:112
method

forEach

Parameters
- next: function
 
 a handler for each value emitted by the observable
 - - (value: T): void
 - Parameters
 - value: T
 Returns void
- Optional PromiseCtor: PromiseConstructor
Returns Promise<void>

a promise that either resolves on observable completion or rejects with the handled error

lift

lift<T, R>(operator: Operator<T, R>): Observable<T>

Inherited from Subject.lift

Overwrites Observable.lift
- Defined in node_modules/rxjs/src/Subject.ts:35
Type parameters
- T
- R
Parameters
- operator: Operator<T, R>
Returns Observable<T>

next(value: T): void

Inherited from Subject.next
- Defined in node_modules/rxjs/src/Subject.ts:82
Parameters
- value: T
Returns void

remove

remove(subscription: Subscription): void

Inherited from Subject.remove
- Defined in node_modules/rxjs/src/Subject.ts:45
Parameters
- subscription: Subscription
Returns void

setup

setup(): void

- Defined in node_modules/rxjs/src/testing/HotObservable.ts:36
Returns void

subscribe(observerOrNext?: PartialObserver | function, error?: function, complete?: function): Subscription

Inherited from Observable.subscribe
- Defined in node_modules/rxjs/src/Observable.ts:86
Registers handlers for handling emitted values, error and completions from the observable, and executes the observable's subscriber function, which will take action to set up the underlying data stream

method

subscribe

Parameters
- Optional observerOrNext: PartialObserver | function
  
  (optional) either an observer defining all functions to be called, or the first of three possible handlers, which is the handler for each value emitted from the observable.
- Optional error: function
  
  (optional) a handler for a terminal event resulting from an error. If no error handler is provided, the error will be thrown as unhandled
  - - (error: any): void
    - Parameters
      - error: any
      Returns void
- Optional complete: function
  
  (optional) a handler for a terminal event resulting from successful completion.
  - - (): void
    - Returns void
Returns Subscription

a subscription reference to the registered handlers

unsubscribe

unsubscribe(): void

Implementation of ISubscription.unsubscribe

Inherited from Subject.unsubscribe
- Defined in node_modules/rxjs/src/Subject.ts:49
Returns void

create

create<T>(destination: Observer<T>, source: Observable<T>): Subject<T>

Inherited from Subject.create

Overwrites Observable.create
- Defined in node_modules/rxjs/src/Subject.ts:17
Type parameters
- T
Parameters
- destination: Observer<T>
- source: Observable<T>
Returns Subject<T>

"node_modules/rxjs/src/testing/SubscriptionLog"

"node_modules/rxjs/src/testing/SubscriptionLog":

SubscriptionLog

SubscriptionLog:

constructor

new SubscriptionLog(subscribedFrame: number, unsubscribedFrame?: number): SubscriptionLog

- Defined in node_modules/rxjs/src/testing/SubscriptionLog.ts:1
Parameters
- subscribedFrame: number
- Default value unsubscribedFrame: number = Number.POSITIVE_INFINITY
Returns SubscriptionLog

subscribedFrame

subscribedFrame: number

unsubscribedFrame

unsubscribedFrame: number

"node_modules/rxjs/src/testing/SubscriptionLoggable"

"node_modules/rxjs/src/testing/SubscriptionLoggable":

SubscriptionLoggable

SubscriptionLoggable:

scheduler

scheduler: Scheduler

subscriptions

subscriptions: SubscriptionLog[]

logSubscribedFrame

logSubscribedFrame(): number

- Defined in node_modules/rxjs/src/testing/SubscriptionLoggable.ts:8
Returns number

logUnsubscribedFrame

logUnsubscribedFrame(index: number): void

- Defined in node_modules/rxjs/src/testing/SubscriptionLoggable.ts:13
Parameters
- index: number
Returns void

"node_modules/rxjs/src/testing/TestMessage"

"node_modules/rxjs/src/testing/TestMessage":

TestMessage

TestMessage:

frame

frame: number

notification

notification: Notification<any>

"node_modules/rxjs/src/testing/TestScheduler"

"node_modules/rxjs/src/testing/TestScheduler":

TestScheduler

TestScheduler:

constructor

new TestScheduler(assertDeepEqual: function): TestScheduler

- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:23
Parameters
- assertDeepEqual: function
  - - (actual: any, expected: any): boolean | void
    - Parameters
      - actual: any
      - expected: any
      Returns boolean | void
Returns TestScheduler

actions

actions: Action<any>[]

active

active: boolean

assertDeepEqual

assertDeepEqual: function

Type declaration

- (actual: any, expected: any): boolean | void
- Parameters
  - actual: any
  - expected: any
  Returns boolean | void

coldObservables

coldObservables: ColdObservable<any>[]

flushTests

flushTests: FlushableTest[]

frame

frame: number

hotObservables

hotObservables: HotObservable<any>[]

index

index: number

maxFrames

maxFrames: number

scheduledId

scheduledId: number

sorted

sorted: boolean

frameTimeFactor

frameTimeFactor: number

addAction

addAction<T>(action: Action<T>): void

Inherited from VirtualTimeScheduler.addAction
- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:41
Type parameters
- T
Parameters
- action: Action<T>
Returns void

createColdObservable

createColdObservable<T>(marbles: string, values?: any, error?: any): Observable<T>

- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:37
Type parameters
- T
Parameters
- marbles: string
- Optional values: any
- Optional error: any
Returns Observable<T>

createHotObservable

createHotObservable<T>(marbles: string, values?: any, error?: any): Subject<T>

- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:50
Type parameters
- T
Parameters
- marbles: string
- Optional values: any
- Optional error: any
Returns Subject<T>

createTime

createTime(marbles: string): number

- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:29
Parameters
- marbles: string
Returns number

expectObservable

expectObservable(observable: Observable<any>, unsubscriptionMarbles?: string): object

- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:73
Parameters
- observable: Observable<any>
- Default value unsubscriptionMarbles: string = null
Returns object
- toBe: observableToBeFn

expectSubscriptions

expectSubscriptions(actualSubscriptionLogs: SubscriptionLog[]): object

- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:110
Parameters
- actualSubscriptionLogs: SubscriptionLog[]
Returns object
- toBe: subscriptionLogsToBeFn

flush

flush(): void

Implementation of Scheduler.flush

Overwrites VirtualTimeScheduler.flush
- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:124
Returns void

materializeInnerObservable

materializeInnerObservable(observable: Observable<any>, outerFrame: number): TestMessage[]

- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:60
Parameters
- observable: Observable<any>
- outerFrame: number
Returns TestMessage[]

now

now(): number

Implementation of Scheduler.now

Inherited from VirtualTimeScheduler.now
- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:16
Returns number

schedule

schedule<T>(work: function, delay?: number, state?: T): Subscription

Inherited from VirtualTimeScheduler.schedule
- Defined in node_modules/rxjs/src/scheduler/VirtualTimeScheduler.ts:63
Type parameters
- T
Parameters
- work: function
  - - (x?: T): Subscription | void
    - Parameters
      - Optional x: T
      Returns Subscription | void
- Default value delay: number = 0
- Optional state: T
Returns Subscription

parseMarbles

parseMarbles(marbles: string, values?: any, errorValue?: any, materializeInnerObservables?: boolean): TestMessage[]

- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:187
Parameters
- marbles: string
- Optional values: any
- Optional errorValue: any
- Default value materializeInnerObservables: boolean = false
Returns TestMessage[]

parseMarblesAsSubscriptions

parseMarblesAsSubscriptions(marbles: string): SubscriptionLog

- Defined in node_modules/rxjs/src/testing/TestScheduler.ts:138
Parameters
- marbles: string
Returns SubscriptionLog

FlushableTest

FlushableTest:

actual

actual: any[]

expected

expected: any[]

ready

ready: boolean

observableToBeFn

observableToBeFn: function

Type declaration

- (marbles: string, values?: any, errorValue?: any): void
- Parameters
  - marbles: string
  - Optional values: any
  - Optional errorValue: any
  Returns void

subscriptionLogsToBeFn

subscriptionLogsToBeFn: function

Type declaration

- (marbles: string | string[]): void
- Parameters
  - marbles: string | string[]
  Returns void

"node_modules/rxjs/src/util/AnimationFrame"

"node_modules/rxjs/src/util/AnimationFrame":

RequestAnimationFrameDefinition

RequestAnimationFrameDefinition:

constructor

new RequestAnimationFrameDefinition(root: any): RequestAnimationFrameDefinition

- Defined in node_modules/rxjs/src/util/AnimationFrame.ts:5
Parameters
- root: any
Returns RequestAnimationFrameDefinition

cancelAnimationFrame

cancelAnimationFrame: function

Type declaration

- (handle: number): void
- Parameters
  - handle: number
  Returns void

requestAnimationFrame

requestAnimationFrame: function

Type declaration

- (cb: function): number
- Parameters
  - cb: function
    - - (): void
      - Returns void
  Returns number

AnimationFrame

AnimationFrame: RequestAnimationFrameDefinition

"node_modules/rxjs/src/util/ArgumentOutOfRangeError"

"node_modules/rxjs/src/util/ArgumentOutOfRangeError":

ArgumentOutOfRangeError

ArgumentOutOfRangeError:

An error thrown when an element was queried at a certain index of an Observable, but no such index or position exists in that sequence.

see: elementAt
see: take
see: takeLast
class: ArgumentOutOfRangeError

constructor

new ArgumentOutOfRangeError(): ArgumentOutOfRangeError

- Defined in node_modules/rxjs/src/util/ArgumentOutOfRangeError.ts:11
Returns ArgumentOutOfRangeError

Error

Error: ErrorConstructor

message

message: string

name

stack

stack: string

"node_modules/rxjs/src/util/EmptyError"

"node_modules/rxjs/src/util/EmptyError":

EmptyError

EmptyError:

An error thrown when an Observable or a sequence was queried but has no elements.

see: first
see: last
see: single
class: EmptyError

constructor

new EmptyError(): EmptyError

- Defined in node_modules/rxjs/src/util/EmptyError.ts:11
Returns EmptyError

Error

Error: ErrorConstructor

message

message: string

name

stack

stack: string

"node_modules/rxjs/src/util/FastMap"

"node_modules/rxjs/src/util/FastMap":

FastMap

FastMap:

values

values: Object

clear

clear(): void

- Defined in node_modules/rxjs/src/util/FastMap.ts:27
Returns void

delete

delete(key: string): boolean

- Defined in node_modules/rxjs/src/util/FastMap.ts:4
Parameters
- key: string
Returns boolean

forEach

forEach(cb: function, thisArg?: any): void

- Defined in node_modules/rxjs/src/util/FastMap.ts:18
Parameters
- cb: function
  - - (value: any, key: any): void
    - Parameters
      - value: any
      - key: any
      Returns void
- Optional thisArg: any
Returns void

get

get(key: string): any

- Defined in node_modules/rxjs/src/util/FastMap.ts:14
Parameters
- key: string
Returns any

set

set(key: string, value: any): FastMap

- Defined in node_modules/rxjs/src/util/FastMap.ts:9
Parameters
- key: string
- value: any
Returns FastMap

"node_modules/rxjs/src/util/Immediate"

"node_modules/rxjs/src/util/Immediate":

ImmediateDefinition

ImmediateDefinition:

constructor

new ImmediateDefinition(root: any): ImmediateDefinition

- Defined in node_modules/rxjs/src/util/Immediate.ts:20
Parameters
- root: any
Returns ImmediateDefinition

clearImmediate

clearImmediate: function

Type declaration

- (handle: number): void
- Parameters
  - handle: number
  Returns void

currentlyRunningATask

currentlyRunningATask: boolean

nextHandle

nextHandle: number

root

root: any

setImmediate

setImmediate: function

Type declaration

- (cb: function): number
- Parameters
  - cb: function
    - - (): void
      - Returns void
  Returns number

tasksByHandle

tasksByHandle: any

addFromSetImmediateArguments

addFromSetImmediateArguments(args: any[]): number

- Defined in node_modules/rxjs/src/util/Immediate.ts:108
Parameters
- args: any[]
Returns number

canUseMessageChannel

canUseMessageChannel(): boolean

- Defined in node_modules/rxjs/src/util/Immediate.ts:63
Returns boolean

canUsePostMessage

canUsePostMessage(): boolean

- Defined in node_modules/rxjs/src/util/Immediate.ts:72
Returns boolean

canUseProcessNextTick

canUseProcessNextTick(): boolean

- Defined in node_modules/rxjs/src/util/Immediate.ts:59
Returns boolean

canUseReadyStateChange

canUseReadyStateChange(): boolean

- Defined in node_modules/rxjs/src/util/Immediate.ts:67
Returns boolean

createMessageChannelSetImmediate

createMessageChannelSetImmediate(): setImmediate

- Defined in node_modules/rxjs/src/util/Immediate.ts:179
Returns setImmediate

createPostMessageSetImmediate

createPostMessageSetImmediate(): setImmediate

- Defined in node_modules/rxjs/src/util/Immediate.ts:126
Returns setImmediate

createProcessNextTickSetImmediate

createProcessNextTickSetImmediate(): setImmediate

- Defined in node_modules/rxjs/src/util/Immediate.ts:113
Returns setImmediate

createReadyStateChangeSetImmediate

createReadyStateChangeSetImmediate(): setImmediate

- Defined in node_modules/rxjs/src/util/Immediate.ts:199
Returns setImmediate

createSetTimeoutSetImmediate

createSetTimeoutSetImmediate(): setImmediate

- Defined in node_modules/rxjs/src/util/Immediate.ts:225
Returns setImmediate

identify

identify(o: any): string

- Defined in node_modules/rxjs/src/util/Immediate.ts:12
Parameters
- o: any
Returns string

partiallyApplied

partiallyApplied(handler: any, ...args: any[]): result

- Defined in node_modules/rxjs/src/util/Immediate.ts:92
Parameters
- handler: any
- Rest ...args: any[]
Returns result

runIfPresent

runIfPresent(handle: any): void

- Defined in node_modules/rxjs/src/util/Immediate.ts:158
Parameters
- handle: any
Returns void

Immediate

Immediate: ImmediateDefinition

"node_modules/rxjs/src/util/Map"

"node_modules/rxjs/src/util/Map":

Map

Map: any

"node_modules/rxjs/src/util/MapPolyfill"

"node_modules/rxjs/src/util/MapPolyfill":

MapPolyfill

MapPolyfill:

_keys

_keys: any[]

_values

_values: any[]

size

size: number

clear

clear(): void

- Defined in node_modules/rxjs/src/util/MapPolyfill.ts:32
Returns void

delete

delete(key: any): boolean

- Defined in node_modules/rxjs/src/util/MapPolyfill.ts:23
Parameters
- key: any
Returns boolean

forEach

forEach(cb: Function, thisArg: any): void

- Defined in node_modules/rxjs/src/util/MapPolyfill.ts:38
Parameters
- cb: Function
- thisArg: any
Returns void

get

get(key: any): any

- Defined in node_modules/rxjs/src/util/MapPolyfill.ts:6
Parameters
- key: any
Returns any

set

set(key: any, value: any): MapPolyfill

- Defined in node_modules/rxjs/src/util/MapPolyfill.ts:11
Parameters
- key: any
- value: any
Returns MapPolyfill

"node_modules/rxjs/src/util/ObjectUnsubscribedError"

"node_modules/rxjs/src/util/ObjectUnsubscribedError":

ObjectUnsubscribedError

ObjectUnsubscribedError:

An error thrown when an action is invalid because the object has been unsubscribed.

see: Subject
see: BehaviorSubject
class: ObjectUnsubscribedError

constructor

new ObjectUnsubscribedError(): ObjectUnsubscribedError

- Defined in node_modules/rxjs/src/util/ObjectUnsubscribedError.ts:10
Returns ObjectUnsubscribedError

Error

Error: ErrorConstructor

message

message: string

name

stack

stack: string

"node_modules/rxjs/src/util/UnsubscriptionError"

"node_modules/rxjs/src/util/UnsubscriptionError":

UnsubscriptionError

UnsubscriptionError:

An error thrown when one or more errors have occurred during the unsubscribe of a Subscription.

constructor

new UnsubscriptionError(errors: any[]): UnsubscriptionError

- Defined in node_modules/rxjs/src/util/UnsubscriptionError.ts:5
Parameters
- errors: any[]
Returns UnsubscriptionError

errors

errors: any[]

Error

Error: ErrorConstructor

message

message: string

name

stack

stack: string

"node_modules/rxjs/src/util/applyMixins"

"node_modules/rxjs/src/util/applyMixins":

applyMixins

applyMixins(derivedCtor: any, baseCtors: any[]): void

- Defined in node_modules/rxjs/src/util/applyMixins.ts:1
Parameters
- derivedCtor: any
- baseCtors: any[]
Returns void

"node_modules/rxjs/src/util/assign"

"node_modules/rxjs/src/util/assign":

Object

Object: any

assign

assign: function

Type declaration

- (target: Object, ...sources: Array<Object>): Object
- Parameters
 - target: Object
 - Rest ...sources: Array<Object>
 Returns Object

"node_modules/rxjs/src/util/errorObject"

"node_modules/rxjs/src/util/errorObject":

errorObject

errorObject: object

e

e: object

Type declaration

"node_modules/rxjs/src/util/isArray"

"node_modules/rxjs/src/util/isArray":

isArray

isArray: isArray

"node_modules/rxjs/src/util/isDate"

"node_modules/rxjs/src/util/isDate":

isDate

isDate(value: any): boolean

- Defined in node_modules/rxjs/src/util/isDate.ts:1
Parameters
- value: any
Returns boolean

"node_modules/rxjs/src/util/isFunction"

"node_modules/rxjs/src/util/isFunction":

isFunction

isFunction(x: any): boolean

- Defined in node_modules/rxjs/src/util/isFunction.ts:1
Parameters
- x: any
Returns boolean

"node_modules/rxjs/src/util/isNumeric"

"node_modules/rxjs/src/util/isNumeric":

isNumeric

isNumeric(val: any): boolean

- Defined in node_modules/rxjs/src/util/isNumeric.ts:3
Parameters
- val: any
Returns boolean

"node_modules/rxjs/src/util/isObject"

"node_modules/rxjs/src/util/isObject":

isObject

isObject(x: any): boolean

- Defined in node_modules/rxjs/src/util/isObject.ts:1
Parameters
- x: any
Returns boolean

"node_modules/rxjs/src/util/isPromise"

"node_modules/rxjs/src/util/isPromise":

isPromise

isPromise<T>(value: any | Promise<T>): boolean

- Defined in node_modules/rxjs/src/util/isPromise.ts:1
Type parameters
- T
Parameters
- value: any | Promise<T>
Returns boolean

"node_modules/rxjs/src/util/isScheduler"

"node_modules/rxjs/src/util/isScheduler":

isScheduler

isScheduler<T>(value: any): boolean

- Defined in node_modules/rxjs/src/util/isScheduler.ts:2
Type parameters
- T
Parameters
- value: any
Returns boolean

"node_modules/rxjs/src/util/noop"

"node_modules/rxjs/src/util/noop":

noop

noop(): void

- Defined in node_modules/rxjs/src/util/noop.ts:2
Returns void

"node_modules/rxjs/src/util/not"

"node_modules/rxjs/src/util/not":

not

not(pred: Function, thisArg: any): Function

- Defined in node_modules/rxjs/src/util/not.ts:1
Parameters
- pred: Function
- thisArg: any
Returns Function

"node_modules/rxjs/src/util/root"

"node_modules/rxjs/src/util/root":

NodeJS

NodeJS:

Global

Global:

global

global: any

window

window: any

exports

exports: any

freeExports

freeExports: any

freeGlobal

freeGlobal: Global

freeModule

freeModule: any

global

global: Global

module

module: any

root

root: any

objectTypes

objectTypes: object

boolean

boolean: boolean

function

function: boolean

number

number: boolean

object

object: boolean

string

string: boolean

undefined

undefined: boolean

"node_modules/rxjs/src/util/subscribeToResult"

"node_modules/rxjs/src/util/subscribeToResult":

subscribeToResult

subscribeToResult<T, R>(outerSubscriber: OuterSubscriber<T, R>, result: any, outerValue?: T, outerIndex?: number): Subscription

- Defined in node_modules/rxjs/src/util/subscribeToResult.ts:12
Type parameters
- T
- R
Parameters
- outerSubscriber: OuterSubscriber<T, R>
- result: any
- Optional outerValue: T
- Optional outerIndex: number
Returns Subscription

"node_modules/rxjs/src/util/throwError"

"node_modules/rxjs/src/util/throwError":

throwError

throwError(e: any): void

- Defined in node_modules/rxjs/src/util/throwError.ts:1
Parameters
- e: any
Returns void

"node_modules/rxjs/src/util/toSubscriber"

"node_modules/rxjs/src/util/toSubscriber":

toSubscriber

toSubscriber<T>(nextOrObserver?: PartialObserver | function, error?: function, complete?: function): Subscriber<T>

- Defined in node_modules/rxjs/src/util/toSubscriber.ts:5
Type parameters
- T
Parameters
- Optional nextOrObserver: PartialObserver | function
- Optional error: function
 - - (error: any): void
 - Parameters
 - error: any
 Returns void
- Optional complete: function
 - - (): void
 - Returns void
Returns Subscriber<T>

"node_modules/rxjs/src/util/tryCatch"

"node_modules/rxjs/src/util/tryCatch":

tryCatchTarget

tryCatchTarget: Function

tryCatch

tryCatch<T>(fn: T): T

- Defined in node_modules/rxjs/src/util/tryCatch.ts:14
Type parameters
- T: Function
Parameters
- fn: T
Returns T

tryCatcher

tryCatcher(): any

- Defined in node_modules/rxjs/src/util/tryCatch.ts:5
Returns any

"node_modules/zone.js/lib/browser/browser"

"node_modules/zone.js/lib/browser/browser":

XHROptions

XHROptions:

aborted

aborted: boolean

args

args: any[]

delay

delay: number

Delay in milliseconds when the Task will run.

isPeriodic

isPeriodic: boolean

A periodic [MacroTask] is such which get automatically rescheduled after it is executed.

target

target: any

XHR_TASK

XHR_TASK: string

_global

_global: Global | Window

blockingMethods

blockingMethods: Array<string>

clear

clear: string

set

set: string

patchXHR

patchXHR(window: any): void

- Defined in node_modules/zone.js/lib/browser/browser.ts:49
Parameters
- window: any
Returns void

"node_modules/zone.js/lib/browser/define-property"

"node_modules/zone.js/lib/browser/define-property":

_create

_create: create

_defineProperty

_defineProperty: defineProperty

_getOwnPropertyDescriptor

_getOwnPropertyDescriptor: getOwnPropertyDescriptor

unconfigurablesKey

unconfigurablesKey: string

_redefineProperty

_redefineProperty(obj: any, prop: any, desc: any): any

- Defined in node_modules/zone.js/lib/browser/define-property.ts:48
Parameters
- obj: any
- prop: any
- desc: any
Returns any

isUnconfigurable

isUnconfigurable(obj: any, prop: any): any

- Defined in node_modules/zone.js/lib/browser/define-property.ts:53
Parameters
- obj: any
- prop: any
Returns any

propertyPatch

propertyPatch(): void

- Defined in node_modules/zone.js/lib/browser/define-property.ts:12
Returns void

rewriteDescriptor

rewriteDescriptor(obj: any, prop: any, desc: any): any

- Defined in node_modules/zone.js/lib/browser/define-property.ts:57
Parameters
- obj: any
- prop: any
- desc: any
Returns any

"node_modules/zone.js/lib/browser/event-target"

"node_modules/zone.js/lib/browser/event-target":

EVENT_TARGET

EVENT_TARGET: string

NO_EVENT_TARGET

NO_EVENT_TARGET: Array<string>

WTF_ISSUE_555

WTF_ISSUE_555: string

eventTargetPatch

eventTargetPatch(_global: any): void

- Defined in node_modules/zone.js/lib/browser/event-target.ts:7
Parameters
- _global: any
Returns void

"node_modules/zone.js/lib/browser/property-descriptor"

"node_modules/zone.js/lib/browser/property-descriptor":

eventNames

eventNames: Array<string>

unboundKey

unboundKey: string

canPatchViaPropertyDescriptor

canPatchViaPropertyDescriptor(): boolean

- Defined in node_modules/zone.js/lib/browser/property-descriptor.ts:39
Returns boolean

patchViaCapturingAllTheEvents

patchViaCapturingAllTheEvents(): void

- Defined in node_modules/zone.js/lib/browser/property-descriptor.ts:64
Returns void

propertyDescriptorPatch

propertyDescriptorPatch(_global: any): void

- Defined in node_modules/zone.js/lib/browser/property-descriptor.ts:6
Parameters
- _global: any
Returns void

"node_modules/zone.js/lib/browser/register-element"

"node_modules/zone.js/lib/browser/register-element":

registerElementPatch

registerElementPatch(_global: any): void

- Defined in node_modules/zone.js/lib/browser/register-element.ts:4
Parameters
- _global: any
Returns void

"node_modules/zone.js/lib/browser/websocket"

"node_modules/zone.js/lib/browser/websocket":

apply

apply(_global: any): void

- Defined in node_modules/zone.js/lib/browser/websocket.ts:4
Parameters
- _global: any
Returns void

"node_modules/zone.js/lib/common/timers"

"node_modules/zone.js/lib/common/timers":

TimerOptions

TimerOptions:

args

args: any[]

delay

delay: number

Delay in milliseconds when the Task will run.

handleId

handleId: number

isPeriodic

isPeriodic: boolean

A periodic [MacroTask] is such which get automatically rescheduled after it is executed.

patchTimer

patchTimer(window: any, setName: string, cancelName: string, nameSuffix: string): void

- Defined in node_modules/zone.js/lib/common/timers.ts:8
Parameters
- window: any
- setName: string
- cancelName: string
- nameSuffix: string
Returns void

"node_modules/zone.js/lib/common/utils"

"node_modules/zone.js/lib/common/utils":

ListenerTaskMeta

ListenerTaskMeta:

delay

delay: number

Delay in milliseconds when the Task will run.

eventName

eventName: string

handler

handler: EventListenerOrEventListenerObject

isPeriodic

isPeriodic: boolean

A periodic [MacroTask] is such which get automatically rescheduled after it is executed.

name

target

target: any

useCapturing

useCapturing: boolean

ADD_EVENT_LISTENER

ADD_EVENT_LISTENER: string

EVENT_TASKS

EVENT_TASKS: string

REMOVE_EVENT_LISTENER

REMOVE_EVENT_LISTENER: string

SYMBOL_ADD_EVENT_LISTENER

SYMBOL_ADD_EVENT_LISTENER: string

SYMBOL_REMOVE_EVENT_LISTENER

SYMBOL_REMOVE_EVENT_LISTENER: string

WorkerGlobalScope

WorkerGlobalScope: any

Suppress closure compiler errors about unknown 'process' variable

fileoverview
suppress: {undefinedVars}

_global

_global: Global | Window

isBrowser

isBrowser: boolean

isNode

isNode: boolean

isWebWorker

isWebWorker: boolean

originalInstanceKey

originalInstanceKey: string

zoneSymbol

zoneSymbol: function

Type declaration

- (name: string): string
- Parameters
  - name: string
  Returns string

attachRegisteredEvent

attachRegisteredEvent(target: any, eventTask: Task): void

- Defined in node_modules/zone.js/lib/common/utils.ts:145
Parameters
- target: any
- eventTask: Task
Returns void

bindArguments

bindArguments(args: any[], source: string): any[]

- Defined in node_modules/zone.js/lib/common/utils.ts:12
Parameters
- args: any[]
- source: string
Returns any[]

cancelEventListener

cancelEventListener(eventTask: Task): void

- Defined in node_modules/zone.js/lib/common/utils.ts:160
Parameters
- eventTask: Task
Returns void

createNamedFn

createNamedFn(name: string, delegate: function): Function

- Defined in node_modules/zone.js/lib/common/utils.ts:292
Parameters
- name: string
- delegate: function
  - - (self: any, args: any[]): any
    - Parameters
      - self: any
      - args: any[]
      Returns any
Returns Function

findExistingRegisteredTask

findExistingRegisteredTask(target: any, handler: any, name: string, capture: boolean, remove: boolean): Task

- Defined in node_modules/zone.js/lib/common/utils.ts:123
Parameters
- target: any
- handler: any
- name: string
- capture: boolean
- remove: boolean
Returns Task

patchClass

patchClass(className: any): void

- Defined in node_modules/zone.js/lib/common/utils.ts:243
Parameters
- className: any
Returns void

patchEventTargetMethods

patchEventTargetMethods(obj: any): boolean

- Defined in node_modules/zone.js/lib/common/utils.ts:230
Parameters
- obj: any
Returns boolean

patchMethod

patchMethod(target: any, name: string, patchFn: function): Function

- Defined in node_modules/zone.js/lib/common/utils.ts:309
Parameters
- target: any
- name: string
- patchFn: function
  - - (delegate: Function, delegateName: string, name: string): function
    - Parameters
      - delegate: Function
      - delegateName: string
      - name: string
      Returns function
      - (self: any, args: any[]): any
        
        Parameters
        
        self: any
        
        args: any[]
        
        Returns any
Returns Function

patchOnProperties

patchOnProperties(obj: any, properties: string[]): void

- Defined in node_modules/zone.js/lib/common/utils.ts:92
Parameters
- obj: any
- properties: string[]
Returns void

patchProperty

patchProperty(obj: any, prop: any): void

- Defined in node_modules/zone.js/lib/common/utils.ts:46
Parameters
- obj: any
- prop: any
Returns void

patchPrototype

patchPrototype(prototype: any, fnNames: any): void

- Defined in node_modules/zone.js/lib/common/utils.ts:21
Parameters
- prototype: any
- fnNames: any
Returns void

scheduleEventListener

scheduleEventListener(eventTask: Task): any

- Defined in node_modules/zone.js/lib/common/utils.ts:153
Parameters
- eventTask: Task
Returns any

zoneAwareAddEventListener

zoneAwareAddEventListener(self: any, args: any[]): any

- Defined in node_modules/zone.js/lib/common/utils.ts:168
Parameters
- self: any
- args: any[]
Returns any

zoneAwareRemoveEventListener

zoneAwareRemoveEventListener(self: any, args: any[]): void

- Defined in node_modules/zone.js/lib/common/utils.ts:214
Parameters
- self: any
- args: any[]
Returns void

"node_modules/zone.js/lib/jasmine/jasmine"

"node_modules/zone.js/lib/jasmine/jasmine":

SET_TIMEOUT

SET_TIMEOUT: string

_global

_global: Global | Window

"node_modules/zone.js/lib/node/node"

"node_modules/zone.js/lib/node/node":

_global

_global: Global | Window

clear

clear: string

crypto

crypto: any

set

set: string

shouldPatchGlobalTimers

shouldPatchGlobalTimers: boolean

timers

timers: any

"node_modules/zone.js/lib/zone"

"node_modules/zone.js/lib/zone":

EventTask

EventTask:

callback

callback: Function

Function which needs to be executed by the Task after the [Zone.currentTask] has been set to the current task.

cancelFn

cancelFn: function

Represents the default work which needs to be done to un-schedule the Task from the VM. Not all Tasks are cancelable, and therefore this method is optional.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

- (task: Task): void
- Parameters
  - task: Task
  Returns void

data

data: TaskData

Task specific options associated with the current task. This is passed to the scheduleFn.

invoke

invoke: Function

The Function to be used by the VM on entering the [Task]. This function will delegate to [Zone.runTask] and delegate to callback.

runCount

runCount: number

Number of times the task has been executed, or -1 if canceled.

scheduleFn

scheduleFn: function

Represents the default work which needs to be done to schedule the Task by the VM.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

- (task: Task): void
- Parameters
  - task: Task
  Returns void

source

source: string

Debug string representing the API which requested the scheduling of the task.

type

type: TaskType

Task type: microTask, macroTask, eventTask.

zone

zone: Zone

type: {Zone} The zone which will be used to invoke the callback. The Zone is captured at the time of Task creation.

MacroTask

MacroTask:

callback

callback: Function

Function which needs to be executed by the Task after the [Zone.currentTask] has been set to the current task.

cancelFn

cancelFn: function

Represents the default work which needs to be done to un-schedule the Task from the VM. Not all Tasks are cancelable, and therefore this method is optional.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

- (task: Task): void
- Parameters
  - task: Task
  Returns void

data

data: TaskData

Task specific options associated with the current task. This is passed to the scheduleFn.

invoke

invoke: Function

The Function to be used by the VM on entering the [Task]. This function will delegate to [Zone.runTask] and delegate to callback.

runCount

runCount: number

Number of times the task has been executed, or -1 if canceled.

scheduleFn

scheduleFn: function

Represents the default work which needs to be done to schedule the Task by the VM.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

- (task: Task): void
- Parameters
  - task: Task
  Returns void

source

source: string

Debug string representing the API which requested the scheduling of the task.

type

type: TaskType

Task type: microTask, macroTask, eventTask.

zone

zone: Zone

type: {Zone} The zone which will be used to invoke the callback. The Zone is captured at the time of Task creation.

MicroTask

MicroTask:

callback

callback: Function

Function which needs to be executed by the Task after the [Zone.currentTask] has been set to the current task.

cancelFn

cancelFn: function

Represents the default work which needs to be done to un-schedule the Task from the VM. Not all Tasks are cancelable, and therefore this method is optional.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

- (task: Task): void
- Parameters
  - task: Task
  Returns void

data

data: TaskData

Task specific options associated with the current task. This is passed to the scheduleFn.

invoke

invoke: Function

The Function to be used by the VM on entering the [Task]. This function will delegate to [Zone.runTask] and delegate to callback.

runCount

runCount: number

Number of times the task has been executed, or -1 if canceled.

scheduleFn

scheduleFn: function

Represents the default work which needs to be done to schedule the Task by the VM.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

- (task: Task): void
- Parameters
  - task: Task
  Returns void

source

source: string

Debug string representing the API which requested the scheduling of the task.

type

type: TaskType

Task type: microTask, macroTask, eventTask.

zone

zone: Zone

type: {Zone} The zone which will be used to invoke the callback. The Zone is captured at the time of Task creation.

Task

Task:

Represents work which is executed with a clean stack.

Tasks are used in Zones to mark work which is performed on clean stack frame. There are three kinds of task. [MicroTask], [MacroTask], and [EventTask].

A JS VM can be modeled as a [MicroTask] queue, [MacroTask] queue, and [EventTask] set.

[MicroTask] queue represents a set of tasks which are executing right after the current stack frame becomes clean and before a VM yield. All [MicroTask]s execute in order of insertion before VM yield and the next [MacroTask] is executed.
[MacroTask] queue represents a set of tasks which are executed one at a time after each VM yield. The queue is order by time, and insertions can happen in any location.
[EventTask] is a set of tasks which can at any time be inserted to the end of the [MacroTask] queue. This happens when the event fires.

callback

callback: Function

Function which needs to be executed by the Task after the [Zone.currentTask] has been set to the current task.

cancelFn

cancelFn: function

Represents the default work which needs to be done to un-schedule the Task from the VM. Not all Tasks are cancelable, and therefore this method is optional.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

- (task: Task): void
- Parameters
  - task: Task
  Returns void

data

data: TaskData

Task specific options associated with the current task. This is passed to the scheduleFn.

invoke

invoke: Function

The Function to be used by the VM on entering the [Task]. This function will delegate to [Zone.runTask] and delegate to callback.

runCount

runCount: number

Number of times the task has been executed, or -1 if canceled.

scheduleFn

scheduleFn: function

Represents the default work which needs to be done to schedule the Task by the VM.

A zone may chose to intercept this function and perform its own scheduling.

Type declaration

- (task: Task): void
- Parameters
  - task: Task
  Returns void

source

source: string

Debug string representing the API which requested the scheduling of the task.

type

type: TaskType

Task type: microTask, macroTask, eventTask.

zone

zone: Zone

type: {Zone} The zone which will be used to invoke the callback. The Zone is captured at the time of Task creation.

TaskData

TaskData:

delay

delay: number

Delay in milliseconds when the Task will run.

isPeriodic

isPeriodic: boolean

A periodic [MacroTask] is such which get automatically rescheduled after it is executed.

Zone

Zone:

Zone is a mechanism for intercepting and keeping track of asynchronous work.

A Zone is a global object which is configured with rules about how to intercept and keep track of the asynchronous callbacks. Zone has these responsibilities:

Intercept asynchronous task scheduling
Wrap callbacks for error-handling and zone tracking across async operations.
Provide a way to attach data to zones
Provide a context specific last frame error handling
(Intercept blocking methods)

A zone by itself does not do anything, instead it relies on some other code to route existing platform API through it. (The zone library ships with code which monkey patches all of the browsers's asynchronous API and redirects them through the zone for interception.)

In its simplest form a zone allows one to intercept the scheduling and calling of asynchronous operations, and execute additional code before as well as after the asynchronous task. The rules of interception are configured using [ZoneConfig]. There can be many different zone instances in a system, but only one zone is active at any given time which can be retrieved using [Zone#current].

Callback Wrapping

An important aspect of the zones is that they should persist across asynchronous operations. To achieve this, when a future work is scheduled through async API, it is necessary to capture, and subsequently restore the current zone. For example if a code is running in zone b and it invokes setTimeout to scheduleTask work later, the setTimeout method needs to 1) capture the current zone and 2) wrap the wrapCallback in code which will restore the current zone b once the wrapCallback executes. In this way the rules which govern the current code are preserved in all future asynchronous tasks. There could be a different zone c which has different rules and is associated with different asynchronous tasks. As these tasks are processed, each asynchronous wrapCallback correctly restores the correct zone, as well as preserves the zone for future asynchronous callbacks.

Example: Suppose a browser page consist of application code as well as third-party advertisement code. (These two code bases are independent, developed by different mutually unaware developers.) The application code may be interested in doing global error handling and so it configures the app zone to send all of the errors to the server for analysis, and then executes the application in the app zone. The advertising code is interested in the same error processing but it needs to send the errors to a different third-party. So it creates the ads zone with a different error handler. Now both advertising as well as application code create many asynchronous operations, but the [Zone] will ensure that all of the asynchronous operations created from the application code will execute in app zone with its error handler and all of the advertisement code will execute in the ads zone with its error handler. This will not only work for the async operations created directly, but also for all subsequent asynchronous operations.

If you think of chain of asynchronous operations as a thread of execution (bit of a stretch) then [Zone#current] will act as a thread local variable.

Asynchronous operation scheduling

In addition to wrapping the callbacks to restore the zone, all operations which cause a scheduling of work for later are routed through the current zone which is allowed to intercept them by adding work before or after the wrapCallback as well as using different means of achieving the request. (Useful for unit testing, or tracking of requests). In some instances such as setTimeout the wrapping of the wrapCallback and scheduling is done in the same wrapCallback, but there are other examples such as Promises where the then wrapCallback is wrapped, but the execution of then in triggered by Promise scheduling resolve work.

Fundamentally there are three kinds of tasks which can be scheduled:

[MicroTask] used for doing work right after the current task. This is non-cancelable which is guaranteed to run exactly once and immediately.
[MacroTask] used for doing work later. Such as setTimeout. This is typically cancelable which is guaranteed to execute at least once after some well understood delay.
[EventTask] used for listening on some future event. This may execute zero or more times, with an unknown delay.

Each asynchronous API is modeled and routed through one of these APIs.

[MicroTask]

[MicroTask]s represent work which will be done in current VM turn as soon as possible, before VM yielding.

[TimerTask]

[TimerTask]s represents work which will be done after some delay. (Sometimes the delay is approximate such as on next available animation frame). Typically these methods include: setTimeout, setImmediate, setInterval, requestAnimationFrame, and all browser specif variants.

[EventTask]

[EventTask]s represents a request to create a listener on an event. Unlike the other task events may never be executed, but typically execute more then once. There is no queue of events, rather their callbacks are unpredictable both in order and time.

Global Error Handling

Composability

Zones can be composed together through [Zone.fork()]. A child zone may create its own set of rules. A child zone is expected to either:

Delegate the interception to a parent zone, and optionally add before and after wrapCallback hook.s 2) Or process the request itself without delegation.

Composability allows zones to keep their concerns clean. For example a top most zone may chose to handle error handling, while child zones may chose to do user action tracking.

Root Zone

At the start the browser will run in a special root zone, which is configure to behave exactly like the platform, making any existing code which is not-zone aware behave as expected. All zones are children of the root zone.

name

returns: The Zone name (useful for debugging)

parent

parent: Zone

returns: The parent Zone.

cancelTask

cancelTask(task: Task): any

- Defined in node_modules/zone.js/lib/zone.ts:212
Allows the zone to intercept canceling of scheduled Task.

The interception is configured using [ZoneSpec.onCancelTask]. The default canceler invokes the [Task.cancelFn].

Parameters
- task: Task
Returns any

fork

fork(zoneSpec: ZoneSpec): Zone

- Defined in node_modules/zone.js/lib/zone.ts:149
Used to create a child zone.

Parameters
- zoneSpec: ZoneSpec
  
  A set of rules which the child zone should follow.
Returns Zone

A new child zone.

get

get(key: string): any

- Defined in node_modules/zone.js/lib/zone.ts:142
Returns a value associated with the key.

If the current zone does not have a key, the request is delegated to the parent zone. Use [ZoneSpec.properties] to configure the set of properties asseciated with the current zone.

Parameters
- key: string
  
  The key to retrieve.
Returns any

Tha value for the key, or undefined if not found.

run

run<T>(callback: Function, applyThis?: any, applyArgs?: any[], source?: string): T

- Defined in node_modules/zone.js/lib/zone.ts:175
Invokes a function in a given zone.

The invocation of callback can be intercepted be declaring [ZoneSpec.onInvoke].

Type parameters
- T
Parameters
- callback: Function
  
  The function to invoke.
- Optional applyThis: any
- Optional applyArgs: any[]
- Optional source: string
  
  A unique debug location of the API being invoked.
Returns T

Value from the callback function.

runGuarded

runGuarded<T>(callback: Function, applyThis?: any, applyArgs?: any[], source?: string): T

- Defined in node_modules/zone.js/lib/zone.ts:190
Invokes a function in a given zone and catches any exceptions.

Any exceptions thrown will be forwarded to [Zone.HandleError].

The invocation of callback can be intercepted be declaring [ZoneSpec.onInvoke]. The handling of exceptions can intercepted by declaring [ZoneSpec.handleError].

Type parameters
- T
Parameters
- callback: Function
  
  The function to invoke.
- Optional applyThis: any
- Optional applyArgs: any[]
- Optional source: string
  
  A unique debug location of the API being invoked.
Returns T

Value from the callback function.

runTask

runTask(task: Task, applyThis?: any, applyArgs?: any): any

- Defined in node_modules/zone.js/lib/zone.ts:199
Execute the Task by restoring the [Zone.currentTask] in the Task's zone.

Parameters
- task: Task
- Optional applyThis: any
- Optional applyArgs: any
Returns any

scheduleEventTask

scheduleEventTask(source: string, callback: Function, data: TaskData, customSchedule: function, customCancel: function): EventTask

- Defined in node_modules/zone.js/lib/zone.ts:202
Parameters
- source: string
- callback: Function
- data: TaskData
- customSchedule: function
  - - (task: Task): void
    - Parameters
      - task: Task
      Returns void
- customCancel: function
  - - (task: Task): void
    - Parameters
      - task: Task
      Returns void
Returns EventTask

scheduleMacroTask

scheduleMacroTask(source: string, callback: Function, data: TaskData, customSchedule: function, customCancel: function): MacroTask

- Defined in node_modules/zone.js/lib/zone.ts:201
Parameters
- source: string
- callback: Function
- data: TaskData
- customSchedule: function
  - - (task: Task): void
    - Parameters
      - task: Task
      Returns void
- customCancel: function
  - - (task: Task): void
    - Parameters
      - task: Task
      Returns void
Returns MacroTask

scheduleMicroTask

scheduleMicroTask(source: string, callback: Function, data?: TaskData, customSchedule?: function): MicroTask

- Defined in node_modules/zone.js/lib/zone.ts:200
Parameters
- source: string
- callback: Function
- Optional data: TaskData
- Optional customSchedule: function
  - - (task: Task): void
    - Parameters
      - task: Task
      Returns void
Returns MicroTask

wrap

wrap(callback: Function, source: string): Function

- Defined in node_modules/zone.js/lib/zone.ts:163
Wraps a callback function in a new function which will properly restore the current zone upon invocation.

The wrapped function will properly forward this as well as arguments to the callback.

Before the function is wrapped the zone can intercept the callback by declaring [ZoneSpec.onIntercept].

Parameters
- callback: Function
  
  the function which will be wrapped in the zone.
- source: string
  
  A unique debug location of the API being wrapped.
Returns Function

A function which will invoke the callback through [Zone.runGuarded].

ZoneDelegate

ZoneDelegate:

A delegate when intercepting zone operations.

A ZoneDelegate is needed because a child zone can't simply invoke a method on a parent zone. For example a child zone wrap can't just call parent zone wrap. Doing so would create a callback which is bound to the parent zone. What we are interested is intercepting the callback before it is bound to any zone. Furthermore, we also need to pass the targetZone (zone which received the original request) to the delegate.

The ZoneDelegate methods mirror those of Zone with an addition of extra targetZone argument in the method signature. (The original Zone which received the request.) Some methods are renamed to prevent confusion, because they have slightly different semantics and arguments.

wrap => intercept: The wrap method delegates to intercept. The wrap method returns a callback which will run in a given zone, where as intercept allows wrapping the callback so that additional code can be run before and after, but does not associated the callback with the zone.
run => invoke: The run method delegates to invoke to perform the actual execution of the callback. The run method switches to new zone; saves and restores the Zone.current; and optionally performs error handling. The invoke is not responsible for error handling, or zone management.

Not every method is usually overwritten in the child zone, for this reason the ZoneDelegate stores the closest zone which overwrites this behavior along with the closest ZoneSpec.

NOTE: We have tried to make this API analogous to Event bubbling with target and current properties.

Note: The ZoneDelegate treats ZoneSpec as class. This allows the ZoneSpec to use its this to store internal state.

zone

zone: Zone

cancelTask

cancelTask(targetZone: Zone, task: Task): any

- Defined in node_modules/zone.js/lib/zone.ts:370
Parameters
- targetZone: Zone
- task: Task
Returns any

fork

fork(targetZone: Zone, zoneSpec: ZoneSpec): Zone

- Defined in node_modules/zone.js/lib/zone.ts:364
Parameters
- targetZone: Zone
- zoneSpec: ZoneSpec
Returns Zone

handleError

handleError(targetZone: Zone, error: any): boolean

- Defined in node_modules/zone.js/lib/zone.ts:367
Parameters
- targetZone: Zone
- error: any
Returns boolean

hasTask

hasTask(targetZone: Zone, isEmpty: HasTaskState): void

- Defined in node_modules/zone.js/lib/zone.ts:371
Parameters
- targetZone: Zone
- isEmpty: HasTaskState
Returns void

intercept

intercept(targetZone: Zone, callback: Function, source: string): Function

- Defined in node_modules/zone.js/lib/zone.ts:365
Parameters
- targetZone: Zone
- callback: Function
- source: string
Returns Function

invoke

invoke(targetZone: Zone, callback: Function, applyThis: any, applyArgs: any[], source: string): any

- Defined in node_modules/zone.js/lib/zone.ts:366
Parameters
- targetZone: Zone
- callback: Function
- applyThis: any
- applyArgs: any[]
- source: string
Returns any

invokeTask

invokeTask(targetZone: Zone, task: Task, applyThis: any, applyArgs: any): any

- Defined in node_modules/zone.js/lib/zone.ts:369
Parameters
- targetZone: Zone
- task: Task
- applyThis: any
- applyArgs: any
Returns any

scheduleTask

scheduleTask(targetZone: Zone, task: Task): Task

- Defined in node_modules/zone.js/lib/zone.ts:368
Parameters
- targetZone: Zone
- task: Task
Returns Task

ZoneSpec

ZoneSpec:

Provides a way to configure the interception of zone events.

Only the name property is required (all other are optional).

name

The name of the zone. Usefull when debugging Zones.

onCancelTask

onCancelTask: function

Allows interception of task cancelation.

param: Delegate which performs the parent [ZoneSpec] operation.
param: The current [Zone] where the current interceptor has beed declared.
param: The [Zone] which originally received the request.
param: The argument passed into the cancelTask method.

Type declaration

- (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, task: Task): any
- Parameters
  - parentZoneDelegate: ZoneDelegate
  - currentZone: Zone
  - targetZone: Zone
  - task: Task
  Returns any

onFork

onFork: function

Allows the interception of zone forking.

When the zone is being forked, the request is forwarded to this method for interception.

param: Delegate which performs the parent [ZoneSpec] operation.
param: The current [Zone] where the current interceptor has beed declared.
param: The [Zone] which originally received the request.
param: The argument passed into the fork method.

Type declaration

- (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, zoneSpec: ZoneSpec): Zone
- Parameters
  - parentZoneDelegate: ZoneDelegate
  - currentZone: Zone
  - targetZone: Zone
  - zoneSpec: ZoneSpec
  Returns Zone

onHandleError

onHandleError: function

Allows interception of the error handling.

param: Delegate which performs the parent [ZoneSpec] operation.
param: The current [Zone] where the current interceptor has beed declared.
param: The [Zone] which originally received the request.
param: The argument passed into the handleError method.

Type declaration

- (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, error: any): boolean
- Parameters
  - parentZoneDelegate: ZoneDelegate
  - currentZone: Zone
  - targetZone: Zone
  - error: any
  Returns boolean

onHasTask

onHasTask: function

Notifies of changes to the task queue empty status.

param: Delegate which performs the parent [ZoneSpec] operation.
param: The current [Zone] where the current interceptor has beed declared.
param: The [Zone] which originally received the request.
param

Type declaration

- (delegate: ZoneDelegate, current: Zone, target: Zone, hasTaskState: HasTaskState): void
- Parameters
  - delegate: ZoneDelegate
  - current: Zone
  - target: Zone
  - hasTaskState: HasTaskState
  Returns void

onIntercept

onIntercept: function

Allows interception of the wrapping of the callback.

param: Delegate which performs the parent [ZoneSpec] operation.
param: The current [Zone] where the current interceptor has beed declared.
param: The [Zone] which originally received the request.
param: The argument passed into the warp method.
param: The argument passed into the warp method.

Type declaration

- (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, delegate: Function, source: string): Function
- Parameters
  - parentZoneDelegate: ZoneDelegate
  - currentZone: Zone
  - targetZone: Zone
  - delegate: Function
  - source: string
  Returns Function

onInvoke

onInvoke: function

Allows interception of the callback invocation.

param: Delegate which performs the parent [ZoneSpec] operation.
param: The current [Zone] where the current interceptor has beed declared.
param: The [Zone] which originally received the request.
param: The argument passed into the run method.
param: The argument passed into the run method.
param: The argument passed into the run method.
param: The argument passed into the run method.

Type declaration

- (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, delegate: Function, applyThis: any, applyArgs: any[], source: string): any
- Parameters
  - parentZoneDelegate: ZoneDelegate
  - currentZone: Zone
  - targetZone: Zone
  - delegate: Function
  - applyThis: any
  - applyArgs: any[]
  - source: string
  Returns any

onInvokeTask

onInvokeTask: function

Type declaration

- (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, task: Task, applyThis: any, applyArgs: any): any
- Parameters
  - parentZoneDelegate: ZoneDelegate
  - currentZone: Zone
  - targetZone: Zone
  - task: Task
  - applyThis: any
  - applyArgs: any
  Returns any

onScheduleTask

onScheduleTask: function

Allows interception of task scheduling.

param: Delegate which performs the parent [ZoneSpec] operation.
param: The current [Zone] where the current interceptor has beed declared.
param: The [Zone] which originally received the request.
param: The argument passed into the scheduleTask method.

Type declaration

- (parentZoneDelegate: ZoneDelegate, currentZone: Zone, targetZone: Zone, task: Task): Task
- Parameters
  - parentZoneDelegate: ZoneDelegate
  - currentZone: Zone
  - targetZone: Zone
  - task: Task
  Returns Task

properties

properties: object

A set of properties to be associated with Zone. Use [Zone.get] to retrive them.

Type declaration

[key: string]: any

ZoneType

ZoneType:

current

current: Zone

returns: Returns the current [Zone]. Returns the current zone. The only way to change the current zone is by invoking a run() method, which will update the current zone for the duration of the run method callback.

currentTask

currentTask: Task

returns: The task associated with the current execution.

AmbientZone

AmbientZone: Zone

internal

AmbientZoneDelegate

AmbientZoneDelegate: ZoneDelegate

internal

HasTaskState

HasTaskState: object

Type declaration

change: TaskType
eventTask: boolean
macroTask: boolean
microTask: boolean

TaskType

TaskType: string

Task type: microTask, macroTask, eventTask.

"node_modules/zone.js/lib/zone-spec/async-test"

"node_modules/zone.js/lib/zone-spec/async-test":

"node_modules/zone.js/lib/zone-spec/fake-async-test"

"node_modules/zone.js/lib/zone-spec/fake-async-test":

"node_modules/zone.js/lib/zone-spec/long-stack-trace"

"node_modules/zone.js/lib/zone-spec/long-stack-trace":

"node_modules/zone.js/lib/zone-spec/sync-test"

"node_modules/zone.js/lib/zone-spec/sync-test":

"node_modules/zone.js/lib/zone-spec/wtf"

"node_modules/zone.js/lib/zone-spec/wtf":

"src/engine"

"src/engine":

ExpressEngineExtraOptions

ExpressEngineExtraOptions:

bootloader

bootloader: any

client

client: boolean

reuseProviders

reuseProviders: boolean

selector

selector: string

serializedCmp

serializedCmp: string

server

server: boolean

ExpressEngineConfig

ExpressEngineConfig: any

EXPRESS_PLATFORM

EXPRESS_PLATFORM: any

bootstrapApp

bootstrapApp: string

bootstrapButton

bootstrapButton: string

cache

cache: object

Type declaration

fs

fs: any

angularScript

angularScript(config: any): string

- Defined in src/engine.ts:194
Parameters
- config: any
Returns string

bootstrapFunction

bootstrapFunction(config: any): string

- Defined in src/engine.ts:248
Parameters
- config: any
Returns string

buildClientScripts

buildClientScripts(html: string, options: any): string

- Defined in src/engine.ts:273
Parameters
- html: string
- options: any
Returns string

disposeExpressAngularApp

disposeExpressAngularApp(): void

- Defined in src/engine.ts:32
Returns void

disposeExpressPlatform

disposeExpressPlatform(): void

- Defined in src/engine.ts:25
Returns void

expressEngine

expressEngine(filePath: string, options?: ExpressEngineConfig, done?: Function): any

- Defined in src/engine.ts:43
Parameters
- filePath: string
- Optional options: ExpressEngineConfig
- Optional done: Function
Returns any

ng2Engine

ng2Engine(filePath: string, options: ExpressEngineConfig, done: Function): any

- Defined in src/engine.ts:135
Parameters
- filePath: string
- options: ExpressEngineConfig
- done: Function
Returns any

ng2ExpressEngine

ng2ExpressEngine(filePath: string, options: ExpressEngineConfig, done: Function): any

- Defined in src/engine.ts:139
Parameters
- filePath: string
- options: ExpressEngineConfig
- done: Function
Returns any

ng2engine

ng2engine(filePath: string, options: ExpressEngineConfig, done: Function): any

- Defined in src/engine.ts:130
Parameters
- filePath: string
- options: ExpressEngineConfig
- done: Function
Returns any

prebootScript

prebootScript(config: any): string

- Defined in src/engine.ts:183
Parameters
- config: any
Returns string

simpleReplace

simpleReplace(filePath: string, options: ExpressEngineConfig, done: Function): void

- Defined in src/engine.ts:144
Parameters
- filePath: string
- options: ExpressEngineConfig
- done: Function
Returns void

EXPRESS_ANGULAR_APP

EXPRESS_ANGULAR_APP: object

directives

directives: null

providers

providers: null

template

Generated using TypeDoc

Universal Angular 2

Table of Contents

Getting Started

Modules

Universal

Documentation

Videos

preboot.js

Best Practices

What's in a name?

License

Index

External modules

External modules

"index"

"node_modules/angular2-express-engine/index"

"node_modules/angular2-express-engine/src/engine"

ExpressEngineExtraOptions

bootloader

client

reuseProviders

selector

serializedCmp

server

ExpressEngineConfig

EXPRESS_PLATFORM

bootstrapApp

bootstrapButton

cache

Type declaration

fs

angularScript

Parameters

config: any

Returns string

bootstrapFunction

Parameters

config: any

Returns string

buildClientScripts

Parameters

html: string

options: any

Returns string

disposeExpressAngularApp

Returns void

disposeExpressPlatform

Returns void

expressEngine

Parameters

filePath: string

Optional options: ExpressEngineConfig

Optional done: Function

Returns any

ng2Engine

Parameters

filePath: string

options: ExpressEngineConfig

done: Function

Returns any

ng2ExpressEngine

Parameters

filePath: string

options: ExpressEngineConfig

done: Function

Returns any

ng2engine

Parameters

filePath: string

options: ExpressEngineConfig

done: Function

Returns any

prebootScript

Parameters

config: any

Returns string

simpleReplace

Parameters

filePath: string

options: ExpressEngineConfig